Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#42 - refactoring GitHub workflow #45

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Generate commands documentation
name: Generate, update commands documentation

on:
push:
Expand All @@ -7,7 +7,8 @@ on:
- hotfix/*

jobs:
docs-commands-generate:
docs-commands-update:
if: "!contains(github.event.head_commit.message, '[skip docs commands generate]')"
runs-on: ubuntu-22.04
steps:
- name: Checkout
Expand All @@ -28,7 +29,7 @@ jobs:
version: v1.23.0
args: build --clean --skip=validate

- name: Generate and commit new commands documentation
- name: Update and commit new commands documentation
run: |
echo "Configure Git user.name and user.email."
git config user.name github-actions
Expand All @@ -37,7 +38,7 @@ jobs:
echo "Generate new commands documentation."
./dist/rmk_linux_amd64_v1/rmk doc generate > ./docs/commands.md

if (git commit --all --message="[skip ci] Update commands documentation"); then
if (git commit --all --message="[skip docs commands update] Update commands documentation"); then
git push
echo "The new commands documentation has been committed."
fi
2 changes: 1 addition & 1 deletion .github/workflows/docs-publish.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ on:
- 'v[0-9]+.[0-9]+.[0-9]+'

jobs:
publish:
docs-publish:
name: Build, validate, publish, version documentation for GitHub Pages
runs-on: ubuntu-22.04
steps:
Expand Down