-
-
Notifications
You must be signed in to change notification settings - Fork 157
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
update usage documentation for new commands
- Loading branch information
Showing
1 changed file
with
37 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
name: 'Update generated parts of documentation on docs: commits' | ||
|
||
on: | ||
push: | ||
branches: | ||
- master | ||
|
||
jobs: | ||
docs-gen: | ||
name: 'Generate docs and create PR' | ||
# 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:') | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout repo | ||
uses: actions/checkout@v3 | ||
- 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 --if-present | ||
- name: Create Pull Request with updated docs | ||
if: startsWith(github.event.commits[0].message, 'docs:') | ||
uses: peter-evans/create-pull-request@v3 | ||
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 | ||
|