CI: Add job to build API documentation on push to main
#490
Conversation
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
![bmq-oss-ci[bot]](https://avatars.githubusercontent.com/u/1416818?s=60&v=4){kind=small}
pniedzielski
force-pushed
the
generate-doxygen-on-main
branch
from
54a5e8c to
2738f1d
Compare
678098
previously approved these changes
Oct 30, 2024
pniedzielski
force-pushed
the
generate-doxygen-on-main
branch
from
2738f1d to
7d142cb
Compare
pniedzielski
commented
Oct 30, 2024
.github/workflows/documentation.yaml
Outdated
Comment on lines
49
to
53
| cd docs/ | ||
| git config --global user.name "${{ github.actor }}" | ||
| git config --global user.email "${{ github.actor }}@users.noreply.github.com" | ||
| git commit -am "Update C++ API docs from commit ${{ github.sha }} on main" | ||
| git push |
There was a problem hiding this comment.
Based on https://stackoverflow.com/a/58393457 I am not sure whether this will kick off a new build immediately. We may need an personal access token for that.
|
@678098 Can be squash-merged if it's good. |
678098
reviewed
Oct 30, 2024
There was a problem hiding this comment.
@pniedzielski looks good, the only thing is DCO check I think
Signed-off-by: Patrick M. Niedzielski <[email protected]>
Signed-off-by: Patrick M. Niedzielski <[email protected]>
Co-authored-by: Evgeny Malygin <[email protected]> Signed-off-by: Patrick M. Niedzielski <[email protected]>
pniedzielski
force-pushed
the
generate-doxygen-on-main
branch
from
a3f8c03 to
ef07941
Compare
678098
approved these changes
Oct 30, 2024
|
oops, meant to squash... oh well. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a job that runs on pushes to the
mainbranch and on manual workflows to regenerate documentation frommain, and push it to thegh-pagesbranch.In the future we'll want to:
These will be future PRs. This PR is just aimed at getting our website in shape.
Please review this patch carefully. I have run the commands I expect to happen manually in a shell, but if my understanding of the canned GitHub Actions is incorrect, this action may fail in new and fun ways after merge, and I don't believe there is an effective way to test beforehand.