Feat/pages #9
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| name: Build gh-pages | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - '**' | ||
| tags: | ||
| - '**' | ||
| pull_request: | ||
| branches: | ||
| - '**' | ||
|
|
||
| jobs: | ||
| build-gh-pages: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Install build dependencies | ||
| run: | | ||
| sudo apt-get update | ||
| sudo apt-get install -y doxygen sed git python3 | ||
|
|
||
| - name: Checkout source | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| fetch-depth: 0 | ||
|
|
||
| - name: Checkout gh-pages | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| fetch-depth: 0 | ||
| ref: gh-pages | ||
| path: gh-pages | ||
|
|
||
| - name: Mark working directory as safe | ||
| run: git config --global --add safe.directory $GITHUB_WORKSPACE | ||
|
|
||
| - name: Build gh-pages | ||
| shell: bash | ||
| run: | | ||
| BUILDDIR=$(pwd)/docs | ||
| GH_PAGES_DIR_NAME=$(pwd)/gh-pages | ||
| SAFE_BRANCH=$(echo "${GITHUB_REF_NAME}" | tr '/' '-') | ||
| DOCS=${GH_PAGES_DIR_NAME}/${SAFE_BRANCH} | ||
|
|
||
| install -d ${BUILDDIR} | ||
| rm -rf "${BUILDDIR}/html" | ||
| rm -rf "${DOCS}" | ||
|
|
||
| doxygen doxygen.cfg | ||
| touch "${BUILDDIR}/html/.nojekyll" | ||
| mv "${BUILDDIR}/html" ${DOCS} | ||
|
|
||
| cd "${GH_PAGES_DIR_NAME}" && python3 ../docs/create_directory_listing.py | ||
|
|
||
| # add updated branch listing | ||
| cp ${BUILDDIR}/*.css ${GH_PAGES_DIR_NAME}/ | ||
| cp ${BUILDDIR}/index.html ${GH_PAGES_DIR_NAME}/ | ||
|
|
||
| git config user.name "Robert Burger" | ||
| git config user.email "robert.burger@dlr.de" | ||
|
|
||
| git add index.html content.html navtree.css main.css "${SAFE_BRANCH}/*" | ||
| git commit -m 'Automatic update of GH pages' || echo "No changes to commit" | ||
|
|
||
| # Push to gh-pages branch, force update | ||
| if ! git diff --quiet; then | ||
| git push origin HEAD:gh-pages --force | ||
| else | ||
| echo "No changes to push" | ||
| fi | ||
|
|
This file contains hidden or 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
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains hidden or 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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
While changing
BUILDDIRtodocsis consistent with the other changes, this change highlights a critical issue later in thegh-pagestarget. The commands on lines 29-30 use$(BUILDDIR)to copy CSS and HTML files:However, the Doxygen output is generated into
$(BUILDDIR)/html(based ondoxygen.cfg), and this directory is moved to$(DOCS)on line 26. Consequently, thecpcommands on lines 29-30 will fail because the source files do not exist in$(BUILDDIR). This will break thegh-pagesdeployment.This appears to be a pre-existing issue, but since you are modifying
BUILDDIR, it's a good opportunity to fix it. The fix might involve copying the files from$(BUILDDIR)/htmlbefore themvcommand, or from$(DOCS)after it.