From ec2fbfcda5079b50543ded2a0308a6c6bc12192c Mon Sep 17 00:00:00 2001 From: Lev <1187448+levb@users.noreply.github.com> Date: Fri, 8 Mar 2024 18:27:44 -0800 Subject: [PATCH] [ADDED] GitHub action to update docs (#720) * [ADDED] GitHub action to update docs * Removed the caching since I couldn't make it work/test * PR feedback: rm html files before running doxygen --- .github/workflows/update-docs.yml | 45 +++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 .github/workflows/update-docs.yml diff --git a/.github/workflows/update-docs.yml b/.github/workflows/update-docs.yml new file mode 100644 index 000000000..668b1bf8d --- /dev/null +++ b/.github/workflows/update-docs.yml @@ -0,0 +1,45 @@ +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: 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 + + - 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