docs: add verification outcome statement guidance (#215) #122
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: Docs | |
| on: | |
| push: | |
| branches: [main] | |
| paths: | |
| - "docs/**" | |
| - "spec/**" | |
| - "schema/**" | |
| - "Governance/**" | |
| - "PRIVACY.md" | |
| - "overrides/**" | |
| - "robots.txt" | |
| - "mkdocs.yml" | |
| - "requirements-docs.txt" | |
| - "README.md" | |
| - "CHANGELOG.md" | |
| - "CONTRIBUTING.md" | |
| - "GOVERNANCE.md" | |
| - "ROADMAP.md" | |
| - "LIMITATIONS.md" | |
| - "CNAME" | |
| workflow_dispatch: | |
| permissions: | |
| contents: write | |
| concurrency: | |
| group: docs-deploy | |
| cancel-in-progress: false | |
| jobs: | |
| deploy: | |
| name: Build and deploy docs | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v7 | |
| with: | |
| fetch-depth: 0 | |
| - uses: actions/setup-python@v7 | |
| with: | |
| python-version: "3.11" | |
| cache: pip | |
| - name: Install docs dependencies | |
| run: | | |
| pip install -r requirements-docs.txt | |
| pip install -e ".[dev]" | |
| - name: Configure git for gh-deploy | |
| run: | | |
| git config user.name "github-actions[bot]" | |
| git config user.email "github-actions[bot]@users.noreply.github.com" | |
| - name: Assemble docs build directory | |
| run: | | |
| BUILD=.docs_build | |
| mkdir -p $BUILD | |
| if [ -d docs ]; then cp -r docs $BUILD/docs; fi | |
| if [ -d spec ]; then cp -r spec $BUILD/spec; fi | |
| if [ -d examples ]; then cp -r examples $BUILD/examples; fi | |
| if [ -d Governance ]; then cp -r Governance $BUILD/Governance; fi | |
| # schema/ carries pic-trace-bridge-v1.json, whose $id points at this | |
| # host. exclude_docs drops the three that are served from the apex. | |
| if [ -d schema ]; then cp -r schema $BUILD/schema; fi | |
| for fname in index.md CHANGELOG.md CONTRIBUTING.md GOVERNANCE.md CHARTER.md CODE_OF_CONDUCT.md MAINTAINERS.md SPONSORS.md ROADMAP.md LIMITATIONS.md PRIVACY.md CNAME robots.txt; do | |
| if [ -f "$fname" ]; then cp "$fname" "$BUILD/$fname"; fi | |
| done | |
| echo "Build dir contains $(find $BUILD -type f | wc -l) files" | |
| - name: Generate build config | |
| run: | | |
| sed 's|^docs_dir: \.$|docs_dir: .docs_build|' mkdocs.yml > .mkdocs_build.yml | |
| - name: Build and deploy to GitHub Pages | |
| run: mkdocs gh-deploy --force --clean --config-file .mkdocs_build.yml |