Skip to content

Commit

Permalink
Merge pull request #45 from edenlabllc/feature/RMK-42-fix-markdown-he…
Browse files Browse the repository at this point in the history
…aders-in-rmk-doc-generate-to-display-correctly-in-the-web-documentation

#42 - refactoring GitHub workflow
  • Loading branch information
apanasiuk-el authored Sep 3, 2024
2 parents 3598e56 + 56a0f1b commit 2b37748
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
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

0 comments on commit 2b37748

Please sign in to comment.