Confirm fault-decode extractor via disassembly (#38); drop dead mfg-cluster writes (#39) #30
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
| # Publish the documentation to GitHub Pages so it is INDEXABLE. | |
| # | |
| # The GitHub wiki was not: GitHub serves every /wiki/ URL with `X-Robots-Tag: none` (noindex, | |
| # nofollow at the HTTP level), so nothing there could appear in a search engine or the crawlers | |
| # behind AI search. Pages carries no such header. The guide pages therefore now live in the repo | |
| # under docs/guide/ and the wiki is retired, so there is ONE copy of each document and no chance | |
| # of the two drifting apart. | |
| name: Docs site | |
| on: | |
| push: | |
| branches: [main] | |
| paths: | |
| - docs-site/** | |
| - docs/guide/** | |
| - firmware/docs/** | |
| - reverse-engineering/docs/** | |
| - README.md | |
| - .github/workflows/pages.yaml | |
| - .github/scripts/assemble_docs_site.py # the assembler IS the build; changing it must rebuild | |
| pull_request: # build-only on PRs: catches a broken site config BEFORE it reaches main | |
| paths: | |
| - docs-site/** | |
| - docs/guide/** | |
| - firmware/docs/** | |
| - reverse-engineering/docs/** | |
| - .github/workflows/pages.yaml | |
| - .github/scripts/assemble_docs_site.py | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| concurrency: | |
| group: pages | |
| cancel-in-progress: false | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 | |
| - name: Assemble the site | |
| run: | | |
| python3 .github/scripts/assemble_docs_site.py | |
| - uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5.0.0 | |
| - uses: actions/jekyll-build-pages@44a6e6beabd48582f863aeeb6cb2151cc1716697 # v1.0.13 | |
| with: | |
| source: ./_site_src | |
| destination: ./_site | |
| - uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3.0.1 | |
| deploy: | |
| needs: build | |
| if: github.event_name != 'pull_request' | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - id: deployment | |
| uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5 | |
| # Tell IndexNow the site changed, instead of waiting to be crawled. Runs AFTER deploy so the | |
| # URLs (and the key file it verifies) are actually live. The key is not a secret: engines | |
| # authenticate by fetching it from the site, which is why it is committed rather than stored | |
| # as a repo secret. Never allowed to fail the workflow -- a submission endpoint being down | |
| # says nothing about whether the site published. | |
| - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 | |
| - name: Ping IndexNow | |
| continue-on-error: true | |
| env: | |
| INDEXNOW_KEY: 851d5c2c194e53141e515a7c9f456d91 | |
| run: python3 .github/scripts/indexnow_ping.py |