Consolidate environment variable docs into one reference #5
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: 'Environment config drift' | |
| # The environment variable table in the client environment configuration | |
| # reference is hand-written, but the variables it documents live in six other | |
| # repositories. This job reports when the table and those sources disagree. | |
| # | |
| # It runs on a schedule rather than per PR because it fetches sources over the | |
| # network: a GitHub outage should not block unrelated documentation PRs. It also | |
| # runs on demand, and on PRs that touch the reference page or the checker itself. | |
| on: | |
| schedule: | |
| # Mondays at 15:00 UTC. | |
| - cron: '0 15 * * 1' | |
| workflow_dispatch: | |
| pull_request: | |
| paths: | |
| - 'docs/references/client-environment-configuration.mdx' | |
| - 'bin/check-env-config-table.js' | |
| - '.github/workflows/env-config-drift.yml' | |
| permissions: | |
| contents: read | |
| jobs: | |
| check: | |
| name: 'Compare the reference table against every implementation' | |
| runs-on: ubuntu-latest | |
| defaults: | |
| run: | |
| shell: bash | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 | |
| with: | |
| persist-credentials: false | |
| - name: Setup Node | |
| uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0 | |
| with: | |
| node-version: 24 | |
| - name: Check for drift | |
| run: node bin/check-env-config-table.js |