fix: make a changed setting stick, and give back the storage an insta… #25
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: Deploy Docs | |
| # The site is built here and published from the artifact, which means the | |
| # repository setting has to be "GitHub Actions" rather than a branch. | |
| # | |
| # It was a branch, serving `main:/docs` through Jekyll, and that is worth | |
| # recording because the symptom was confusing rather than obvious. Two | |
| # publishers were pointed at one site: this workflow uploading `docs/site`, and | |
| # GitHub's own Jekyll build rendering the whole of `docs/`. The setting picked | |
| # Jekyll, so what a visitor got was the product requirements, the architecture | |
| # and technical specifications, the risk matrix and the implementation plans, | |
| # with `docs/site` buried as a subdirectory nothing linked to. This workflow ran | |
| # on every push, reported success, and changed nothing anyone could see. | |
| on: | |
| push: | |
| branches: [main] | |
| # Every input the site is built from, not only the site directory. The two | |
| # documents below are rendered into pages by build-docs-site.py, so a | |
| # correction to the user guide that did not appear on the site was the | |
| # obvious failure to leave available here. | |
| paths: | |
| - "docs/site/**" | |
| - "docs/USER_GUIDE.md" | |
| - "docs/PRIVACY_POLICY.md" | |
| - "scripts/build-docs-site.py" | |
| - ".github/workflows/pages.yml" | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| concurrency: | |
| group: pages | |
| cancel-in-progress: true | |
| jobs: | |
| deploy: | |
| name: Deploy to GitHub Pages | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 | |
| with: | |
| persist-credentials: false | |
| - name: Set up Python | |
| uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0 | |
| with: | |
| python-version: "3.12" | |
| - name: Install the Markdown renderer | |
| # Pinned, because the site's HTML is this package's output and an | |
| # unpinned renderer changes the published pages without a commit. | |
| run: python -m pip install --require-hashes -r docs/site/requirements.txt | |
| - name: Render the documents into pages | |
| run: python3 scripts/build-docs-site.py | |
| - name: Setup Pages | |
| uses: actions/configure-pages@45bfe0192ca1faeb007ade9deae92b16b8254a0d # v6.0.0 | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0 | |
| with: | |
| path: docs/site | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5.0.0 |