Skip to content
This repository has been archived by the owner on Feb 12, 2024. It is now read-only.

Commit

Permalink
ci: improve doxygen doc publication process
Browse files Browse the repository at this point in the history
  • Loading branch information
jeanpierrefortune committed Dec 30, 2022
1 parent 5733ad3 commit fa90b1b
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 5 deletions.
36 changes: 36 additions & 0 deletions .github/workflows/publish-doc-release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: Publish API documentation (release)

on:
release:
types: [published]

jobs:
publish-doc-release:
runs-on: ubuntu-latest
steps:
- name: Check out repository code from ${{ github.repository }}/${{ github.ref }}
uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Make scripts executable
run: chmod +x ./.github/scripts/*.sh
- name: Check version
working-directory: .
run: ./.github/scripts/check_version.sh $(echo "${{ github.ref }}" | sed -e "s,^refs/tags/,,")
- name: Patch Doxyfile
working-directory: .
run: ./.github/scripts/patch_doxyfile.sh $(echo "${{ github.ref }}" | sed -e "s,^refs/tags/,,")
- name: Generate project documentation with Doxygen
uses: mattnotmitt/doxygen-action@v1.9.2
with:
working-directory: .github/doxygen/
doxyfile-path: ./Doxyfile
- name: Prepare Doxygen doc page locally
working-directory: .
run: ./.github/scripts/prepare_doxygen.sh $(echo "${{ github.ref }}" | sed -e "s,^refs/tags/,,")
- name: Deploy Doxygen documentation to gh-pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./${{ github.event.repository.name }}
enable_jekyll: true
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Publish API documentation
name: Publish API documentation (snapshot)

on:
push:
Expand All @@ -7,7 +7,7 @@ on:
- doxygen

jobs:
publish-doc:
publish-doc-snapshot:
runs-on: ubuntu-latest
steps:
- name: Check out repository code from ${{ github.repository }}/${{ github.ref }}
Expand All @@ -16,9 +16,6 @@ jobs:
fetch-depth: 0
- name: Make scripts executable
run: chmod +x ./.github/scripts/*.sh
- name: Check version
working-directory: .
run: ./.github/scripts/check_version.sh
- name: Patch Doxyfile
working-directory: .
run: ./.github/scripts/patch_doxyfile.sh
Expand Down

0 comments on commit fa90b1b

Please sign in to comment.