Skip to content

Commit

Permalink
CI: Add untracked generated documentation files when publishing
Browse files Browse the repository at this point in the history
If generating the documentation creates files that do not already exist
on the `gh-pages` branch, the current GitHub Action to generate
documentation will not add them.  Instead, it will only update existing
files.  This may happen when a new component is added, or when the
Doxygen version differs from prior runs.  This bit us on our first run
of the documentation-generation GitHub Action, because the version that
GitHub Actions uses is different than the version that built our
original documentation.

This patch explicitly adds all files generated under the
`docs/docs/apidocs/cpp_apidocs` directory, including both untracked
files and tracked, modified files.

Signed-off-by: Patrick M. Niedzielski <[email protected]>
  • Loading branch information
pniedzielski committed Oct 31, 2024
1 parent f10d75f commit 844ba5c
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions .github/workflows/documentation.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -49,5 +49,4 @@ jobs:
cd docs/
git config --global user.name "${{ github.actor }}"
git config --global user.email "${{ github.actor }}@users.noreply.github.com"
git commit -s -am "Update C++ API docs from commit ${{ github.sha }} on main"
git push
git add docs/apidocs/cpp_apidocs/ && git commit -s -am "Update C++ API docs from commit ${{ github.sha }} on main" && git push || true

0 comments on commit 844ba5c

Please sign in to comment.