Use deploy-pages GitHub Action to build and deploy doxygen doc #2446
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
SimeonEhrig
force-pushed
the
ghPagesDeployArtifact
branch
from
3db5abe to
b79b392
Compare
psychocoderHPC
approved these changes
Jan 9, 2025
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.
Instead pushing the generated Doxygen documentation to the
gh-pagesbranch, create an artifact and upload it. With the new solution, we can delete thegh-pagesbranch completely and shrink the size of the repository.The deployment is only possible on the
developbranch. Therefore the step is guarded and we cannot test it in the PR. So we need to merge and hope it is correct. I already tested it my sandbox repository, therefore I think it will work: SimeonEhrig/github-actions-sandbox@b478a20I also guard the deployment step of the single header job.
fix: #2435
For reviewing the PR: you can click on the
Publish documentation to gh-pages / build (pull_request)job and expand the stepUpload HTML output as artifact. There you will see a download link, where you can download the html output of the doxygen doc.