[skip docs commands update] Update commands documentation #24
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
name: Generate, update commands documentation | |
on: | |
push: | |
branches: | |
- develop | |
- hotfix/* | |
jobs: | |
docs-commands-update: | |
if: "!contains(github.event.head_commit.message, '[skip docs commands update]')" | |
runs-on: ubuntu-22.04 | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 | |
token: ${{ secrets.GH_TOKEN_REPO_FULL_ACCESS }} | |
- name: Set up Go | |
uses: actions/setup-go@v4 | |
with: | |
go-version: 1.21 | |
- name: Run GoReleaser artifact build | |
uses: goreleaser/goreleaser-action@v5 | |
with: | |
distribution: goreleaser | |
version: v1.23.0 | |
args: build --clean --skip=validate | |
- name: Update and commit new commands documentation | |
run: | | |
echo "Configure Git user.name and user.email." | |
git config user.name github-actions | |
git config user.email [email protected] | |
echo "Generate new commands documentation." | |
./dist/rmk_linux_amd64_v1/rmk doc generate > ./docs/commands.md | |
if (git commit --all --message="[skip docs commands update] Update commands documentation"); then | |
git push | |
echo "The new commands documentation has been committed." | |
fi |