Skip to content

Update README.md 2

Update README.md 2 #13

Workflow file for this run

name: Update Docs
on:
push:
#branches:
# - main
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: Cache Doxygen
id: cache-doxygen
uses: actions/cache@v4
with:
path: /usr/bin/doxygen
key: doxygen
- name: Set up Doxygen
if: steps.cache-doxygen.outputs.cache-hit != 'true'
run: |
sudo apt-get update
sudo apt-get install -y doxygen
- name: Generate Documentation
id: update
run: |
cd doc
doxygen DoxyFile.NATS.Client
echo '----------------------- <>/<>'
git diff --stat
echo '----------------------- <>/<>'
git diff
echo '----------------------- <>/<>'
git diff --quiet || echo "CHANGES=true" >> $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: Update documentation
branch: update-docs
title: Auto-generated documentation update
body: Documentation changes were detected. Please review and merge.
labels: documentation
base: main
branch-suffix: timestamp
delete-branch: true