Skip to content

Commit

Permalink
feat(ci: docs): add action to publish documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
d4ilyrun committed May 23, 2024
1 parent 4e1c218 commit beab3cf
Showing 1 changed file with 52 additions and 0 deletions.
52 changes: 52 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
name: Deploy documentation

on:
push:
branches: ["master", "docs_test"] # Accept test branch to not polute master

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
deploy:

runs-on: ubuntu-latest

environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

steps:
- name: Checkout
uses: actions/checkout@v4
with:
submodules: recursive

- name: Setup Pages
uses: actions/configure-pages@v5

- name: Generate documentation
uses: mattnotmitt/[email protected]
with:
doxyfile-path: 'docs/doxygen/Doxyfile'

- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: 'docs/doxygen/doc/html'

- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4

0 comments on commit beab3cf

Please sign in to comment.