feat: recipe generation #10
Workflow file for this run
This file contains hidden or 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 | |
| on: | |
| push: | |
| branches: [main] | |
| paths: | |
| - "docs/**" | |
| - ".github/workflows/docs.yml" | |
| pull_request: | |
| paths: | |
| - "docs/**" | |
| - ".github/workflows/docs.yml" | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| jobs: | |
| build: | |
| runs-on: [self-hosted, linux, x64] | |
| timeout-minutes: 15 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| persist-credentials: false | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.12" | |
| - name: Install documentation dependencies | |
| run: | | |
| python -m venv "$RUNNER_TEMP/mosaic-docs-venv" | |
| "$RUNNER_TEMP/mosaic-docs-venv/bin/python" -m pip install -r docs/requirements.txt | |
| - name: Build HTML documentation | |
| run: | | |
| "$RUNNER_TEMP/mosaic-docs-venv/bin/sphinx-build" \ | |
| -W --keep-going -b html -d "$RUNNER_TEMP/mosaic-docs-doctrees" \ | |
| docs docs/_build | |
| - name: Package Pages site | |
| run: | | |
| chmod -R a+rX docs/_build | |
| tar --dereference --hard-dereference \ | |
| --directory docs/_build -cf "$RUNNER_TEMP/artifact.tar" . | |
| # GHES requires the v3 artifact API. | |
| - name: Upload Pages artifact | |
| uses: actions/upload-artifact@v3.2.2-node20 | |
| with: | |
| name: github-pages | |
| path: ${{ runner.temp }}/artifact.tar | |
| if-no-files-found: error | |
| retention-days: 7 | |
| deploy: | |
| if: github.event_name != 'pull_request' && github.ref == 'refs/heads/main' | |
| needs: build | |
| runs-on: [self-hosted, linux, x64] | |
| timeout-minutes: 15 | |
| permissions: | |
| pages: write | |
| id-token: write | |
| concurrency: | |
| group: github-pages | |
| cancel-in-progress: false | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| # deploy-pages v3 supports GHES. v4 uses the GitHub.com artifact API. | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v3 |