Adding PR template (#76) #40
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
# Workflow for deploying doxygen generated reference documentation | |
name: Reference Documentation | |
on: | |
# Runs on pushes targeting the default branch | |
push: | |
branches: | |
- main | |
# Allows 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 one concurrent deployment | |
concurrency: | |
group: "pages" | |
cancel-in-progress: true | |
jobs: | |
deploy-docs: | |
environment: | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
runs-on: ubuntu-latest | |
steps: | |
- uses: cvmfs-contrib/github-action-cvmfs@v4 | |
- name: Checkout | |
uses: actions/checkout@v4 | |
- name: Start container | |
run: | | |
docker run -it --name CI_container \ | |
-v ${GITHUB_WORKSPACE}:/Package \ | |
-v /cvmfs:/cvmfs:shared \ | |
-d ghcr.io/key4hep/key4hep-images/alma9:latest /bin/bash | |
- name: Configure | |
run: | | |
docker exec CI_container /bin/bash -c 'cd ./Package | |
source /cvmfs/sw.hsf.org/key4hep/setup.sh | |
mkdir -p build | |
cd build | |
cmake -G Ninja ..' | |
- name: Build docs | |
run: | | |
docker exec CI_container /bin/bash -c 'cd ./Package | |
source /cvmfs/sw.hsf.org/key4hep/setup.sh | |
cd build | |
ninja -k0 doc' | |
- name: Setup Pages | |
uses: actions/configure-pages@v5 | |
- name: Upload artifact | |
uses: actions/upload-pages-artifact@v3 | |
with: | |
path: './build/doxygen/html' | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v4 |