This repository has been archived by the owner on Feb 12, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ci: improve doxygen doc publication process
- Loading branch information
1 parent
5733ad3
commit fa90b1b
Showing
2 changed files
with
38 additions
and
5 deletions.
There are no files selected for viewing
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
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 |
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