Skip to content

Commit

Permalink
ci: add update-docs workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
Shurtu-gal committed Oct 28, 2023
1 parent deb094e commit e7ccf7f
Show file tree
Hide file tree
Showing 2 changed files with 60 additions and 0 deletions.
18 changes: 18 additions & 0 deletions .github/workflows/global-replicator.yml
Original file line number Diff line number Diff line change
Expand Up @@ -179,4 +179,22 @@ jobs:
committer_username: asyncapi-bot
committer_email: [email protected]
commit_message: "ci: update of files from global .github repo"
bot_branch_name: bot/update-files-from-global-repo

replicate_docs_workflow:
if: startsWith(github.repository, 'asyncapi/')
name: Replicate update-docs workflow to repositories
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Replicating file
uses: derberg/manage-files-in-multiple-repositories@beecbe897cf5ed7f3de5a791a3f2d70102fe7c25
with:
github_token: ${{ secrets.GH_TOKEN }}
patterns_to_include: .github/workflows/update-docs-on-docs-commit.yml
topics_to_include: autogenerate-docs
committer_username: asyncapi-bot
committer_email: [email protected]
commit_message: "ci: update of files from global .github repo"
bot_branch_name: bot/update-files-from-global-repo
42 changes: 42 additions & 0 deletions .github/workflows/update-docs-on-docs-commit.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# This workflow is centrally managed in https://github.com/asyncapi/.github/
# Don't make changes to this file in this repo as they will be overwritten with changes made to the same file in above mentioned repo

# The given workflow is responsible for generating docs and creating PR with them when there is a commit with docs: prefix

# This workflow will be updated in all repos with the topic autogenerate-docs

name: 'Update generated parts of documentation on docs: commits'

on:
push:
branches:
- master

jobs:
docs-gen:
name: 'Generate docs and create PR'
runs-on: ubuntu-latest
# PR should be created within this GH action only if it is a docs: commit
# Otherwise it will conflict with release workflow
if: startsWith(github.event.commits[0].message, 'docs:')
steps:
- name: Checkout repo
uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v3
with:
node-version: 18
- name: Install dependencies
run: npm ci
- name: Regenerate docs
run: npm run generate:assets
- name: Create Pull Request with updated docs
uses: peter-evans/create-pull-request@v5
with:
token: ${{ secrets.GH_TOKEN }}
commit-message: 'chore: update generated docs'
committer: asyncapi-bot <[email protected]>
author: asyncapi-bot <[email protected]>
title: 'chore: update generated docs'
body: 'Update of docs that are generated and were forgotten on PR level.'
branch: gen-docs-update

0 comments on commit e7ccf7f

Please sign in to comment.