Publish documentation #177
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: Publish documentation | |
on: | |
# Runs on pushes targeting the default branch | |
push: | |
branches: ["main"] | |
schedule: | |
- cron: "0 8 * * *" | |
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: | |
linting: | |
uses: ./.github/workflows/linting.yml | |
build-docs: | |
uses: ./.github/workflows/docs.yml | |
run-tests: | |
uses: ./.github/workflows/tests.yml | |
deploy: | |
runs-on: ubuntu-22.04 | |
needs: [build-docs, run-tests] | |
environment: | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
steps: | |
- name: Setup Pages | |
uses: actions/configure-pages@v4 | |
- name: Download docs artifact | |
uses: actions/download-artifact@v3 | |
with: | |
name: documentation | |
path: "./documentation" | |
- name: Download docs artifact | |
uses: actions/download-artifact@v3 | |
with: | |
name: code-coverage-report | |
path: "./documentation/code-coverage-report" | |
- name: Upload page artifact | |
uses: actions/upload-pages-artifact@v2 | |
with: | |
path: "./documentation" | |
- name: Deploy coverage report to GH Pages | |
id: deployment | |
uses: actions/deploy-pages@v3 |