Skip to content

Commit 7634361

Browse files
committed
doc workflow on main -- for testing
1 parent 2e65cd4 commit 7634361

File tree

1 file changed

+62
-0
lines changed

1 file changed

+62
-0
lines changed
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
name: Build Documentation and Deploy
2+
3+
on:
4+
workflow_dispatch:
5+
6+
permissions:
7+
contents: read
8+
id-token: write
9+
pages: write
10+
11+
concurrency:
12+
group: "pages"
13+
cancel-in-progress: true
14+
15+
jobs:
16+
# Build job
17+
build:
18+
runs-on: ubuntu-latest
19+
steps:
20+
# Checkout the repository
21+
- name: Checkout repository
22+
uses: actions/checkout@v2
23+
with:
24+
fetch-depth: 0
25+
submodules: "true"
26+
ref: "feature/toolkit-documentation"
27+
28+
- name: Set Version
29+
run: echo "PROJECT_NUMBER = `git describe --tags`" >> ./docs/doxygen/doxygen-config
30+
31+
- name: Build Documentation
32+
uses: mattnotmitt/[email protected]
33+
with:
34+
doxyfile-path: "./docs/doxygen/doxygen-config"
35+
36+
# Upload the documentation as an artifact
37+
- name: Upload documentation
38+
uses: actions/[email protected]
39+
with:
40+
path: ./docs/html
41+
42+
# Deploy job
43+
deploy:
44+
# Add a dependency to the build job
45+
needs: build
46+
47+
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
48+
permissions:
49+
pages: write # to deploy to Pages
50+
id-token: write # to verify the deployment originates from an appropriate source
51+
52+
# Deploy to the github-pages environment
53+
environment:
54+
name: github-pages
55+
url: ${{ steps.deployment.outputs.page_url }}
56+
57+
# Specify runner + deployment step
58+
runs-on: ubuntu-latest
59+
steps:
60+
- name: Deploy to GitHub Pages
61+
id: deployment
62+
uses: actions/deploy-pages@v4 # or specific "vX.X.X" version tag for this action

0 commit comments

Comments
 (0)