Updated README.md for v3.8.2 (#746) #10
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: Update Docs | |
| on: | |
| push: | |
| branches: | |
| - main | |
| - release_* | |
| jobs: | |
| update-docs: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: write # to push branches | |
| pull-requests: write # to create pull requests | |
| steps: | |
| - name: Checkout Repository | |
| uses: actions/checkout@v4 | |
| - name: Set up Doxygen | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get install -y doxygen | |
| - name: Generate Documentation | |
| id: update | |
| run: | | |
| cd doc | |
| rm -rf ./html/* | |
| doxygen DoxyFile.NATS.Client | |
| git diff --quiet || echo "CHANGES=true" >> $GITHUB_OUTPUT | |
| echo "SOURCE_TITLE=$(git log -1 --pretty=%s)" >> $GITHUB_OUTPUT | |
| echo "SOURCE_SHA=$(git log -1 --pretty=%h)" >> $GITHUB_OUTPUT | |
| - name: Create Pull Request | |
| uses: peter-evans/create-pull-request@v6 | |
| if: steps.update.outputs.CHANGES == 'true' | |
| with: | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| commit-message: "[skip ci] Update docs: ${{ steps.update.outputs.SOURCE_SHA }}: ${{ steps.update.outputs.SOURCE_TITLE }}" | |
| branch: update-docs-${{ github.ref_name }} | |
| title: Auto-generated documentation update for ${{ github.ref_name }} | |
| body: Documentation changes were detected. Please review and merge. | |
| labels: documentation | |
| delete-branch: true |