copilotkit__copilotkit/.github/workflows/stable-release.yml

name: release / create-pr

on:
  workflow_dispatch:
    inputs:
      scope:
        description: "What to release"
        required: true
        type: choice
        options:
          - monorepo
          - angular
          - channels
      bump:
        description: "Version bump level"
        required: true
        type: choice
        options:
          - patch
          - minor
          - major
      dry_run:
        description: "Dry run (preview without creating PR)"
        required: false
        default: false
        type: boolean

concurrency:
  # Scope the lock to the package being released so that, e.g., a `monorepo`
  # create-pr run and an `angular` create-pr run proceed in independent lanes
  # instead of queuing behind each other. Same-scope runs still serialize
  # (cancel-in-progress: false), which is what protects the version bump.
  group: release-pr-${{ inputs.scope }}
  cancel-in-progress: false

permissions:
  contents: write
  pull-requests: write

env:
  NX_VERBOSE_LOGGING: true

jobs:
  create-release-pr:
    if: github.ref == 'refs/heads/main'
    runs-on: ubuntu-latest
    timeout-minutes: 15
    environment: npm
    steps:
      - name: Check for existing release PR
        uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}
          script: |
            const { owner, repo } = context.repo;
            const { data: prs } = await github.rest.pulls.list({
              owner,
              repo,
              state: "open",
              head_prefix: `${owner}:release/publish/`,
            });

            const releasePRs = prs.filter(pr => pr.head.ref.startsWith("release/publish/"));
            if (releasePRs.length > 0) {
              const existing = releasePRs.map(pr => `  - #${pr.number}: ${pr.title} (${pr.html_url})`).join("\n");
              core.setFailed(
                `An open release PR already exists. Close or merge it before creating a new one:\n${existing}`
              );
            }

      - name: Checkout Repo
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7
        with:
          fetch-depth: 0
          token: ${{ secrets.GITHUB_TOKEN }}
          persist-credentials: false

      - name: Setup pnpm
        # Omit `version:` so pnpm/action-setup inherits from the repo's
        # `packageManager` field in package.json (via corepack).
        uses: pnpm/action-setup@ea17c68df8912ef543352723c149a84f56e3d413 # v6.1.0

      - name: Setup Node
        uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
        with:
          node-version: 20.x

      - name: Install Dependencies
        run: pnpm install --frozen-lockfile

      - name: Prepare release
        id: prepare
        run: |
          if [ "${{ inputs.dry_run }}" == "true" ]; then
            pnpm tsx scripts/release/prepare-release.ts --bump ${{ inputs.bump }} --scope ${{ inputs.scope }} --dry-run
          else
            pnpm tsx scripts/release/prepare-release.ts --bump ${{ inputs.bump }} --scope ${{ inputs.scope }}
          fi

      - name: Generate public API manifest
        if: inputs.dry_run != true
        run: pnpm generate:public-api-manifest

      - name: Sync plugin skills
        if: inputs.dry_run != true
        run: pnpm sync:plugin-skills

      - name: Generate AI release notes
        if: inputs.dry_run != true
        id: ai_notes
        run: pnpm tsx scripts/release/generate-ai-release-notes.ts "${{ steps.prepare.outputs.version }}" "${{ inputs.scope }}"
        env:
          ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}

      # release-notes.md is untracked scratch. The lane's CHANGELOG.md is the
      # committed artifact: create-pull-request stages it (a tracked file), the
      # release PR merges it to main, and the publish job reads the section back
      # as the GitHub Release body.
      - name: Record notes in the lane changelog
        if: inputs.dry_run != true
        id: changelog
        run: pnpm tsx scripts/release/write-changelog.ts "${{ steps.prepare.outputs.version }}" "${{ inputs.scope }}"

      - name: Mint devops-bot token
        if: inputs.dry_run != true
        id: app-token
        uses: actions/create-github-app-token@bcd2ba49218906704ab6c1aa796996da409d3eb1 # v3.2.0
        with:
          app-id: 1108748
          private-key: ${{ secrets.DEVOPS_BOT_PRIVATE_KEY }}
          permission-contents: write
          permission-pull-requests: write
          permission-issues: write

      - name: Create release PR
        if: inputs.dry_run != true
        id: create_pr
        uses: peter-evans/create-pull-request@5f6978faf089d4d20b00c7766989d076bb2fc7f1 # v8
        env:
          # The PR branch is validated by CI after creation; do not run local
          # developer pre-commit hooks inside the automation commit.
          LEFTHOOK: "0"
        with:
          token: ${{ steps.app-token.outputs.token }}
          branch: release/publish/${{ inputs.scope }}/v${{ steps.prepare.outputs.version }}
          delete-branch: true
          commit-message: "chore: release ${{ inputs.scope }} v${{ steps.prepare.outputs.version }}"
          title: "chore: release ${{ inputs.scope }} v${{ steps.prepare.outputs.version }}"
          body: |
            ## Release ${{ inputs.scope }} v${{ steps.prepare.outputs.version }}

            **Scope:** `${{ inputs.scope }}` | **Bump:** `${{ inputs.bump }}`

            ---

            ### How this release process works

            1. **This PR was created automatically** by the "release / create-pr" workflow.
               It bumped the `${{ inputs.scope }}` packages to `${{ steps.prepare.outputs.version }}`
               and generated AI-enhanced release notes.

            2. **CI runs on this PR** — the full test suite (unit tests, lint, type checks, build)
               must pass before merging. This is the review gate.

            3. **Review the release notes** in `${{ steps.changelog.outputs.changelog_path }}`
               in this PR. Edit the top section on this branch to change what ships:
               the publish job reads that section back as the GitHub Release body.

            4. **When this PR is merged**, the `release / publish` workflow automatically:
               - Builds all packages
               - Publishes the `${{ inputs.scope }}` packages to npm at version `${{ steps.prepare.outputs.version }}`
               - Creates git tag `${{ inputs.scope }}/v${{ steps.prepare.outputs.version }}`
               - Creates a GitHub Release with the final release notes

            ### Before merging

            - [ ] CI is green (tests, lint, types, build)
            - [ ] Version bumps look correct
            - [ ] Release notes are accurate (edit `${{ steps.changelog.outputs.changelog_path }}` on this branch)

            ---

            > **Do not merge until CI is fully green.** The full test suite runs automatically on this PR.
          labels: release