docs: clarify docs for public viewing #550
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: CI | |
| on: | |
| pull_request: | |
| branches: [main] | |
| push: | |
| branches: [main] | |
| schedule: | |
| - cron: "17 9 * * 1" | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| validate-vendored-assets: | |
| name: Validate vendored assets | |
| uses: ./.github/workflows/validate-vendored-assets.yml | |
| validate-runtime-lock: | |
| name: Validate runtime lock | |
| uses: ./.github/workflows/validate-runtime-lock.yml | |
| dashboard-scenario-snapshots: | |
| name: Dashboard scenario snapshots | |
| runs-on: ubuntu-24.04 | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 | |
| - name: Set up Python | |
| uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0 | |
| with: | |
| python-version: "3.11" | |
| cache: pip | |
| cache-dependency-path: pyproject.toml | |
| - name: Check dashboard scenario snapshots | |
| run: make dashboard-scenario-snapshots | |
| javascript: | |
| name: JavaScript dashboard | |
| runs-on: ubuntu-24.04 | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 | |
| - name: Set up Node | |
| uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0 | |
| with: | |
| node-version: "24" | |
| - name: Test JavaScript modules | |
| run: make js-test | |
| - name: Report JavaScript coverage | |
| run: make js-coverage | |
| - name: Smoke-check dashboard JavaScript runtime | |
| run: make js-smoke | |
| python: | |
| name: Python ${{ matrix.python-version }} | |
| runs-on: ubuntu-24.04 | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| python-version: ["3.11", "3.12", "3.13"] | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 | |
| - name: Set up Python | |
| uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| cache: pip | |
| cache-dependency-path: pyproject.toml | |
| - name: Lint | |
| run: make lint | |
| - name: Type check | |
| if: ${{ matrix.python-version == '3.11' }} | |
| run: make type-check | |
| - name: Validate action metadata | |
| run: make validate-action | |
| - name: Validate workflow YAML | |
| run: make validate-workflows | |
| - name: Test | |
| run: make test | |
| template: | |
| name: Template gates | |
| runs-on: ubuntu-24.04 | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 | |
| - name: Set up Python | |
| uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0 | |
| with: | |
| python-version: "3.11" | |
| cache: pip | |
| cache-dependency-path: pyproject.toml | |
| - name: Verify workflow classification | |
| run: make verify-workflow-classification | |
| - name: Build and verify generated outputs | |
| run: make build-and-verify-generated | |
| - name: Smoke generated template | |
| run: make template-smoke | |
| - name: Run generated template consumer e2e | |
| run: make template-consumer-e2e | |
| - name: Dry-run template publication | |
| run: make publish-template-dry-run | |
| coverage: | |
| name: Coverage | |
| runs-on: ubuntu-24.04 | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 | |
| - name: Set up Python | |
| uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0 | |
| with: | |
| python-version: "3.11" | |
| cache: pip | |
| cache-dependency-path: pyproject.toml | |
| - name: Coverage | |
| run: make coverage | |
| - name: Upload coverage report | |
| if: always() | |
| uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 | |
| with: | |
| name: coverage | |
| path: coverage.xml | |
| if-no-files-found: error | |
| retention-days: 14 |