ci.yml

---
name: CI & Release

on:
  # Build on pushes branches that have a PR (including drafts)
  pull_request:
    branches:
      - main
      - canary
  # Build on commits pushed to branches without a PR if it's in the allowlist
  push:
    branches:
      - main
      - canary
  # https://docs.github.com/en/actions/managing-workflow-runs/manually-running-a-workflow
  # https://github.com/sanity-io/semantic-release-preset/actions/workflows/ci.yml
  workflow_dispatch:
    inputs:
      test:
        description: "Run tests"
        required: true
        default: true
        type: boolean
      release:
        description: "Publish new release"
        required: true
        default: false
        type: boolean

concurrency:
  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
  cancel-in-progress: true

permissions:
  contents: read # for checkout

jobs:
  # log-the-inputs:
  #   runs-on: ubuntu-latest
  #   steps:
  #     - run: |
  #         echo "concurrency.group: $GROUP"
  #         echo "Publish new release: $RELEASE"
  #         echo "Run tests: $TEST"
  #       env:
  #         GROUP: ${{ github.workflow }}-${{ github.head_ref || github.ref }}-${{ github.event.inputs.release || 'no-release' }}
  #         RELEASE: ${{ inputs.release }}
  #         TEST: ${{ inputs.test }}

  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: lts/*
          cache: npm
      - run: npm ci
      - run: npm run lint --if-present
      - run: npm run prepublishOnly --if-present

  test:
    needs: build
    if: github.event.inputs.test != 'false'
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [macos-latest, ubuntu-latest, windows-latest]
        node: [lts/*, current]
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: ${{ matrix.node }}
          cache: npm
      - run: npm ci
      - run: npm test --if-present

  # test-needs-success:
  #   needs: test
  #   if: always() && github.event.inputs.release == 'true' && needs.test.result == 'success'
  #   runs-on: ubuntu-latest
  #   steps:
  #     - env:
  #         NEEDS: ${{ toJSON(needs) }}
  #       run: |
  #         echo "$NEEDS"

  # test-needs-skipped:
  #   needs: test
  #   if: always() && github.event.inputs.release == 'true' && needs.test.result == 'skipped'
  #   runs-on: ubuntu-latest
  #   steps:
  #     - env:
  #         NEEDS: ${{ toJSON(needs) }}
  #       run: |
  #         echo "$NEEDS"

  release:
    permissions:
      contents: write # to be able to publish a GitHub release
      issues: write # to be able to comment on released issues
      pull-requests: write # to be able to comment on released pull requests
      id-token: write # to enable use of OIDC for npm provenance
    needs: test
    # only run if opt-in during workflow_dispatch
    # needs.test.result: 'success' | 'failure' | 'skipped' | 'cancelled'
    # If the state is success or skipped it's safe to do the release
    if: always() && github.event.inputs.release == 'true' && needs.test.result != 'failure' && needs.test.result != 'cancelled'
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - uses: actions/setup-node@v4
        with:
          node-version: lts/*
          cache: npm
      - run: npm ci
      - run: npx semantic-release
        # Don't allow interrupting the release step if the job is cancelled, as it can lead to an inconsistent state
        # e.g. git tags were pushed but it exited before `npm publish`
        if: always()
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          NPM_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}