Skip to content

Commit

Permalink
add workflow to deploy documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
YanzhaoW committed Nov 21, 2024
1 parent 1465041 commit 8e7ce40
Showing 1 changed file with 45 additions and 0 deletions.
45 changes: 45 additions & 0 deletions .github/workflows/publish_doc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: publish-doc
on:
push:
branches:
- dev
workflow_dispatch:

jobs:
artifact-gen:
runs-on: macos-15
defaults:
run:
shell: bash
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
submodules: 'true'
- name: run doxygen
run: |
yes | brew install doxygen graphviz
mkdir -p build
doxygen
- uses: actions/upload-artifact@v4
with:
name: github-pages
path: build/html
retention-days: 1

deploy-doc:
runs-on: macos-15
needs: artifact-gen
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
- name: result
run: echo "Please visit ${{ env.url }} for the doxygen documnetaion."

0 comments on commit 8e7ce40

Please sign in to comment.