angular-release.yml

name: Release TEDI Angular library

on:
  push:
    branches:
      - rc
      - main

jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: "lts/*"
      - name: Lint
        run: |
          npm ci --cache .npm --prefer-offline
          npm run lint

  test:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: "lts/*"
      - name: Test
        run: |
          npm ci --cache .npm --prefer-offline
          npm run test

  # The post-merge build. This is the one that always runs, and its result is
  # what the next pull request's build is compared against, so `rc` must never
  # be skipped. The optional pre-merge build lives in `angular-chromatic.yml`
  # and fires once per pull request, on approval.
  #
  # `needs: [lint, test]` is deliberate: a build that cannot pass its own tests
  # is not worth 600 snapshots against a shared monthly quota.
  chromatic:
    needs: [lint, test]
    runs-on: ubuntu-latest
    permissions:
      contents: read
      pull-requests: write # the result is posted back to the merged PR
    # The `chore(release)` guard is belt and braces. semantic-release pushes
    # its version commit with GITHUB_TOKEN, and a GITHUB_TOKEN push does not
    # trigger workflows at all, so no such run has ever started. It would start
    # mattering the day the release is moved onto a PAT or an app token.
    if: |
      github.event_name == 'push' &&
      (github.ref == 'refs/heads/rc' || github.ref == 'refs/heads/main') &&
      !startsWith(github.event.head_commit.message, 'chore(release)')
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: "lts/*"
      - name: Install dependencies
        run: |
          npm ci --cache .npm --prefer-offline
      - name: Build Storybook
        run: npm run build:sb:chromatic

      # chromaui/action rather than the raw CLI: it surfaces the build result
      # as step outputs (change count, build URL, capture counts), which the
      # two steps below need. exitZeroOnChanges keeps the release green: a
      # visual change is something to review, not a broken build.
      - name: Publish to Chromatic
        id: chromatic
        uses: chromaui/action@v18
        with:
          projectToken: ${{ secrets.CHROMATIC_TOKEN }}
          exitZeroOnChanges: true

      # The rc build runs after the pull request merged, so its result has no
      # PR to land on by default. Map the commit back to its pull request
      # (this resolves correctly for squash merges) and leave a sticky comment
      # there, which is the page the author was last looking at.
      - name: Comment the result on the merged pull request
        if: steps.chromatic.outputs.changeCount != '0' && steps.chromatic.outputs.changeCount != ''
        continue-on-error: true
        uses: actions/github-script@v7
        env:
          CHANGE_COUNT: ${{ steps.chromatic.outputs.changeCount }}
          BUILD_URL: ${{ steps.chromatic.outputs.buildUrl }}
        with:
          script: |
            const { owner, repo } = context.repo;
            const { data: prs } = await github.rest.repos.listPullRequestsAssociatedWithCommit({
              owner, repo, commit_sha: context.sha,
            });
            const pr = prs.find((p) => p.merged_at) ?? prs[0];
            if (!pr) {
              core.info('No pull request is associated with this commit; nothing to comment on.');
              return;
            }
            const marker = '<!-- chromatic-rc -->';
            const branch = context.ref.replace('refs/heads/', '');
            const body = [
              marker,
              '## 🎨 Chromatic',
              '',
              `${process.env.CHANGE_COUNT} visual change(s) were detected on \`${branch}\` after this pull request merged.`,
              '',
              `[Review and accept them](${process.env.BUILD_URL})`,
            ].join('\n');
            const { data: comments } = await github.rest.issues.listComments({
              owner, repo, issue_number: pr.number,
            });
            const existing = comments.find((c) => c.body?.includes(marker));
            if (existing) {
              await github.rest.issues.updateComment({ owner, repo, comment_id: existing.id, body });
            } else {
              await github.rest.issues.createComment({ owner, repo, issue_number: pr.number, body });
            }

      # actualCaptureCount is what is billed at 1x and inheritedCaptureCount is
      # what TurboSnap copied at 0.2x, so this is the real per-build cost
      # against the monthly quota rather than an estimate.
      - name: Record the snapshot usage
        if: always()
        env:
          CAPTURED: ${{ steps.chromatic.outputs.actualCaptureCount }}
          INHERITED: ${{ steps.chromatic.outputs.inheritedCaptureCount }}
          CHANGES: ${{ steps.chromatic.outputs.changeCount }}
          ERRORS: ${{ steps.chromatic.outputs.errorCount }}
          SPECS: ${{ steps.chromatic.outputs.specCount }}
          BUILD_URL: ${{ steps.chromatic.outputs.buildUrl }}
        run: |
          {
            echo "### Chromatic"
            echo ""
            echo "| metric | value |"
            echo "| --- | --- |"
            echo "| Stories | ${SPECS:-n/a} |"
            echo "| Captured (billed 1x) | ${CAPTURED:-n/a} |"
            echo "| Inherited via TurboSnap (billed 0.2x) | ${INHERITED:-n/a} |"
            echo "| Visual changes | ${CHANGES:-n/a} |"
            echo "| Errored stories | ${ERRORS:-n/a} |"
            echo "| Build | ${BUILD_URL:-n/a} |"
          } >> "$GITHUB_STEP_SUMMARY"

  build-and-deploy:
    needs: [lint, test]
    runs-on: ubuntu-latest
    permissions:
      contents: write
      id-token: write
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - name: Use Node.js
        uses: actions/setup-node@v4
        with:
          node-version: "lts/*"
      - name: Build and publish npm package
        run: |
          HUSKY=0
          npm ci
          npm run build
          git pull
          npm run release
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

  merge-to-rc:
    needs: build-and-deploy
    if: github.ref == 'refs/heads/main'
    runs-on: ubuntu-latest
    permissions:
      contents: write
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
        with:
          fetch-depth: 0
          ref: main
      - name: Configure Git
        run: |
          git config user.name "github-actions[bot]"
          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
      - name: Merge main into rc
        run: |
          git fetch origin rc
          git checkout rc
          git merge origin/main --no-edit || true
          git push origin rc