test #5
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
name: Documentation | |
permissions: read-all | |
# Trigger for PR or merge to develop branch | |
on: | |
push: | |
branches: romain/docs | |
paths: | |
- 'docs/**' | |
pull_request: | |
paths: | |
- 'docs/**' | |
workflow_dispatch: | |
jobs: | |
build: | |
runs-on: self-hosted | |
steps: | |
- uses: actions/checkout@44c2b7a8a4ea60a981eaca3cf939b5f4305c123b # v4.1.5 | |
- uses: actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d # v5.1.0 | |
with: | |
python-version: '3.11' | |
cache: 'pip' | |
- name: Install Dependencies | |
run: pip install -r docs/requirements.txt | |
- name: Configure & Build | |
run: | | |
cmake -DCMAKE_VERBOSE_MAKEFILE=on -B build docs | |
cmake --build build | |
- uses: actions/upload-artifact@65462800fd760344b1a7b4382951275a0abb4808 # v4.3.3 | |
with: | |
name: docs | |
path: build/Documentation/html | |
publish: | |
needs: build | |
if: github.event_name == 'workflow_dispatch' || github.event_name == 'push' && github.ref == 'refs/heads/romain/docs' | |
environment: | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
runs-on: self-hosted | |
permissions: | |
contents: write | |
id-token: write | |
pages: write | |
steps: | |
- uses: actions/checkout@44c2b7a8a4ea60a981eaca3cf939b5f4305c123b # v4.1.5 | |
with: | |
ref: gh-pages | |
path: gh-pages | |
- name: Remove old site | |
run: rm -rf gh-pages/* | |
- uses: actions/download-artifact@65a9edc5881444af0b9093a5e628f2fe47ea3b2e # v4.1.7 | |
with: | |
name: docs | |
path: gh-pages | |
- name: Push to GitHub Pages | |
run: | | |
cd gh-pages | |
touch .nojekyll | |
git add . | |
git config --global user.name "GitHub Actions" | |
git config --global user.email [email protected] | |
git commit -m "Update documentation" | |
git push --force origin gh-pages | |
- name: Setup Pages | |
uses: actions/configure-pages@v5 | |
- name: Upload artifact | |
uses: actions/upload-pages-artifact@v3 | |
with: | |
# Upload entire repository | |
path: '.' | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v4 |