Skip to content

Commit 83dc1f9

Browse files
committed
CI: Make apidocs push failures an error
Our API documentation CI workflow has been failing since September due to an unintended change in the `gh-pages` branch protection settings. We didn’t catch this, because the API documentation CI workflow is configured to invariably pass, even if any command fails. This change was made in commit 844ba5c as part of a fix for adding untracked generated documentation, but that fix was overzealous. This patch makes any failure to push to `gh-pages` a CI error. Signed-off-by: Patrick M. Niedzielski <pniedzielski@bloomberg.net>
1 parent 11f6020 commit 83dc1f9

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

.github/workflows/documentation.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,4 +49,5 @@ jobs:
4949
cd docs/
5050
git config --global user.name "${{ github.actor }}"
5151
git config --global user.email "${{ github.actor }}@users.noreply.github.com"
52-
git add docs/apidocs/cpp_apidocs/ && git commit -s -am "Update C++ API docs from commit ${{ github.sha }} on main" && git push || true
52+
git add docs/apidocs/cpp_apidocs/ && git commit -s -am "Update C++ API docs from commit ${{ github.sha }} on main" || true
53+
git push

0 commit comments

Comments
 (0)