deploy.yml

name: Deploy to GitHub Pages

on:
  push:
    branches:
      - main
  workflow_dispatch:
  schedule:
    - cron: '17 * * * *'

permissions:
  contents: write

concurrency:
  group: public-docs-deploy
  cancel-in-progress: true

jobs:
  deploy:
    name: Deploy to GitHub Pages
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-node@v4
        with:
          node-version: 20
          cache: npm

      - name: Plan deployment
        id: deploy-plan
        env:
          DOCS_DEPLOY_EVENT_NAME: ${{ github.event_name }}
        run: node scripts/plan-docs-deploy.js

      - name: Install dependencies
        if: steps.deploy-plan.outputs.deploy == 'true'
        run: npm ci

      - name: Build website
        if: steps.deploy-plan.outputs.deploy == 'true'
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: npm run build

      - name: Verify public artifact tuple
        if: steps.deploy-plan.outputs.deploy == 'true'
        run: |
          node <<'NODE'
          const assert = require('assert');
          const fs = require('fs');

          const expected = require('./scripts/public-artifact-versions.json').artifacts;
          const audit = JSON.parse(fs.readFileSync('build/docs-page-release-audit.json', 'utf8'));
          const quickstart = JSON.parse(fs.readFileSync('build/quickstart-execution-contract.json', 'utf8'));

          for (const [name, version] of Object.entries(expected)) {
            assert.strictEqual(
              audit.artifact_versions && audit.artifact_versions[name],
              version,
              `docs-page-release-audit.json artifact_versions.${name}`
            );

            assert.strictEqual(
              quickstart.artifacts && quickstart.artifacts[name] && quickstart.artifacts[name].version,
              version,
              `quickstart-execution-contract.json artifacts.${name}.version`
            );
          }

          assert.strictEqual(
            audit.release_status_guardrail &&
              audit.release_status_guardrail.stable_default_docs_version,
            '1.x',
            'release audit stable default docs version'
          );
          assert.strictEqual(
            quickstart.default_docs_guard &&
              quickstart.default_docs_guard.stable_default_docs_version,
            '1.x',
            'quickstart stable default docs version'
          );

          console.log(
            `Deploying public artifact tuple: ${Object.entries(expected)
              .map(([name, version]) => `${name}=${version}`)
              .join(', ')}`
          );
          NODE

      # Popular action to deploy to GitHub Pages:
      # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
      - name: Deploy to GitHub Pages
        if: steps.deploy-plan.outputs.deploy == 'true'
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          # Build output to publish to the `gh-pages` branch:
          publish_dir: ./build
          # The following lines assign commit authorship to the official
          # GH-Actions bot for deploys to `gh-pages` branch:
          # https://github.com/actions/checkout/issues/13#issuecomment-724415212
          # The GH actions bot is used by default if you didn't specify the two fields.
          # You can swap them out with your own user credentials.
          user_name: github-actions[bot]
          user_email: 41898282+github-actions[bot]@users.noreply.github.com
          force_orphan: true

      - name: Report current live tuple
        if: steps.deploy-plan.outputs.deploy != 'true'
        run: echo "Live public artifact tuple already matches main; skipping scheduled deploy."