Improved documentation workflow #1
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
| # Simple workflow for deploying static content to GitHub Pages | ||
| # =============================== | ||
| # Documentation Pipeline | ||
| # =============================== | ||
| name: Documentation | ||
| on: | ||
| # Runs on pushes targeting the default branch | ||
| push: | ||
| branches: ["develop"] | ||
| # Allows you 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 only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | ||
| # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | ||
| concurrency: | ||
| group: "pages" | ||
| cancel-in-progress: false | ||
| jobs: | ||
| # -------------------------------- | ||
| # Build : Build the Documentation | ||
| # -------------------------------- | ||
| build: | ||
| name: Build | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v3 | ||
| - name : Build documentation | ||
| uses: devcontainers/[email protected] | ||
| with: | ||
| push: never | ||
| runCmd: | | ||
| make get-informations | ||
| make install-dependencies-docs | ||
| make build-docs | ||
| - name: Upload documentation artifact | ||
| # https://docs.github.com/en/actions/using-workflows/storing-workflow-data-as-artifacts#passing-data-between-jobs-in-a-workflow | ||
| uses: actions/upload-artifact@v4 | ||
| with: | ||
| name: documentation | ||
| path: ./docs/_build/html | ||
| # -------------------------------- | ||
| # Deploy : Deploy the Documentation | ||
| # -------------------------------- | ||
| deploy: | ||
| environment: | ||
| name: github-pages | ||
| url: ${{ steps.deployment.outputs.page_url }} | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
| - name: Setup Pages | ||
| uses: actions/configure-pages@v4 | ||
| - name: Download documentation artifact | ||
| uses: actions/download-artifact@v4 | ||
| with: | ||
| name: documentation | ||
| - name: Upload artifact | ||
| uses: actions/upload-pages-artifact@v3 | ||
| with: | ||
| path: './docs/_build/html' | ||
| - name: Deploy to GitHub Pages | ||
| id: deployment | ||
| uses: actions/deploy-pages@v4 | ||
