release.yml

# This file is automatically added by @npmcli/template-oss. Do not edit.

name: Release

on:
  workflow_dispatch:
    inputs:
      release-pr:
        description: a release PR number to rerun release jobs on
        type: string
  push:
    branches:
      - main

permissions:
  contents: write
  pull-requests: write
  checks: write

jobs:
  release:
    outputs:
      pr: ${{ steps.release.outputs.pr }}
      release: ${{ steps.release.outputs.release }}
      releases: ${{ steps.release.outputs.releases }}
      branch: ${{ steps.release.outputs.pr-branch }}
      pr-number: ${{ steps.release.outputs.pr-number }}
      comment-id: ${{ steps.pr-comment.outputs.result }}
      check-id: ${{ steps.check.outputs.check_id }}
    name: Release
    if: github.repository_owner == 'npm'
    runs-on: ubuntu-latest
    defaults:
      run:
        shell: bash
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Setup Git User
        run: |
          git config --global user.email "npm-cli+bot@github.com"
          git config --global user.name "npm CLI robot"
      - name: Setup Node
        uses: actions/setup-node@v3
        id: node
        with:
          node-version: 20.x
          check-latest: contains('20.x', '.x')

      # node 10/12/14 ship with npm@6, which is known to fail when updating itself in windows
      - name: Update Windows npm
        if: |
          matrix.platform.os == 'windows-latest' && (
            startsWith(steps.node.outputs.node-version, 'v10.') || startsWith(steps.node.outputs.node-version, 'v12.') || startsWith(steps.node.outputs.node-version, 'v14.')
          )
        run: |
          curl -sO https://registry.npmjs.org/npm/-/npm-7.5.4.tgz
          tar xf npm-7.5.4.tgz
          cd package
          node lib/npm.js install --no-fund --no-audit -g ..\npm-7.5.4.tgz
          cd ..
          rmdir /s /q package

      # Start on Node 10 because we dont test on anything lower
      - name: Install npm@7 on Node 10
        shell: bash
        if: startsWith(steps.node.outputs.node-version, 'v10.')
        id: npm-7
        run: |
          npm i --prefer-online --no-fund --no-audit -g npm@7
          echo "updated=true" >> "$GITHUB_OUTPUT"

      - name: Install npm@8 on Node 12
        shell: bash
        if: startsWith(steps.node.outputs.node-version, 'v12.')
        id: npm-8
        run: |
          npm i --prefer-online --no-fund --no-audit -g npm@8
          echo "updated=true" >> "$GITHUB_OUTPUT"

      - name: Install npm@9 on Node 14/16/18.0
        shell: bash
        if: startsWith(steps.node.outputs.node-version, 'v14.') || startsWith(steps.node.outputs.node-version, 'v16.') || startsWith(steps.node.outputs.node-version, 'v18.0.')
        id: npm-9
        run: |
          npm i --prefer-online --no-fund --no-audit -g npm@9
          echo "updated=true" >> "$GITHUB_OUTPUT"

      - name: Install npm@latest on Node
        if: ${{ !(steps.npm-7.outputs.updated || steps.npm-8.outputs.updated || steps.npm-9.outputs.updated) }}
        run: npm i --prefer-online --no-fund --no-audit -g npm@latest

      - name: npm Version
        run: npm -v
      - name: Install Dependencies
        run: npm i --ignore-scripts --no-audit --no-fund
      - name: Release Please
        id: release
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: |
          npx --offline template-oss-release-please "${{ github.ref_name }}" "${{ inputs.release-pr }}"
      - name: Post Pull Request Comment
        if: steps.release.outputs.pr-number
        uses: actions/github-script@v6
        id: pr-comment
        env:
          PR_NUMBER: ${{ steps.release.outputs.pr-number }}
          REF_NAME: ${{ github.ref_name }}
        with:
          script: |
            const { REF_NAME, PR_NUMBER: issue_number } = process.env
            const { runId, repo: { owner, repo } } = context

            const { data: workflow } = await github.rest.actions.getWorkflowRun({ owner, repo, run_id: runId })

            let body = '## Release Manager\n\n'

            const comments = await github.paginate(github.rest.issues.listComments, { owner, repo, issue_number })
            let commentId = comments.find(c => c.user.login === 'github-actions[bot]' && c.body.startsWith(body))?.id

            body += `Release workflow run: ${workflow.html_url}\n\n#### Force CI to Update This Release\n\n`
            body += `This PR will be updated and CI will run for every non-\`chore:\` commit that is pushed to \`${REF_NAME}\`. `
            body += `To force CI to update this PR, run this command:\n\n`
            body += `\`\`\`\ngh workflow run release.yml -r ${REF_NAME} -R ${owner}/${repo} -f release-pr=${issue_number}\n\`\`\``

            if (commentId) {
              await github.rest.issues.updateComment({ owner, repo, comment_id: commentId, body })
            } else {
              const { data: comment } = await github.rest.issues.createComment({ owner, repo, issue_number, body })
              commentId = comment?.id
            }

            return commentId
      - name: Get Workflow Job
        uses: actions/github-script@v6
        if: steps.release.outputs.pr-sha
        id: check-output
        env:
          JOB_NAME: "Release"
          MATRIX_NAME: ""
        with:
          script: |
            const { owner, repo } = context.repo

            const { data } = await github.rest.actions.listJobsForWorkflowRun({
              owner,
              repo,
              run_id: context.runId,
              per_page: 100
            })

            const jobName = process.env.JOB_NAME + process.env.MATRIX_NAME
            const job = data.jobs.find(j => j.name.endsWith(jobName))
            const jobUrl = job?.html_url

            const shaUrl = `${context.serverUrl}/${owner}/${repo}/commit/${{ steps.release.outputs.pr-sha }}`

            let summary = `This check is assosciated with ${shaUrl}\n\n`

            if (jobUrl) {
              summary += `For run logs, click here: ${jobUrl}`
            } else {
              summary += `Run logs could not be found for a job with name: "${jobName}"`
            }

            return { summary }
      - name: Create Check
        uses: LouisBrunner/checks-action@v1.6.0
        id: check
        if: steps.release.outputs.pr-sha
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          status: in_progress
          name: Release
          sha: ${{ steps.release.outputs.pr-sha }}
          output: ${{ steps.check-output.outputs.result }}

  update:
    needs: release
    outputs:
      sha: ${{ steps.commit.outputs.sha }}
      check-id: ${{ steps.check.outputs.check_id }}
    name: Update - Release
    if: github.repository_owner == 'npm' && needs.release.outputs.pr
    runs-on: ubuntu-latest
    defaults:
      run:
        shell: bash
    steps:
      - name: Checkout
        uses: actions/checkout@v3
        with:
          fetch-depth: 0
          ref: ${{ needs.release.outputs.branch }}
      - name: Setup Git User
        run: |
          git config --global user.email "npm-cli+bot@github.com"
          git config --global user.name "npm CLI robot"
      - name: Setup Node
        uses: actions/setup-node@v3
        id: node
        with:
          node-version: 20.x
          check-latest: contains('20.x', '.x')

      # node 10/12/14 ship with npm@6, which is known to fail when updating itself in windows
      - name: Update Windows npm
        if: |
          matrix.platform.os == 'windows-latest' && (
            startsWith(steps.node.outputs.node-version, 'v10.') || startsWith(steps.node.outputs.node-version, 'v12.') || startsWith(steps.node.outputs.node-version, 'v14.')
          )
        run: |
          curl -sO https://registry.npmjs.org/npm/-/npm-7.5.4.tgz
          tar xf npm-7.5.4.tgz
          cd package
          node lib/npm.js install --no-fund --no-audit -g ..\npm-7.5.4.tgz
          cd ..
          rmdir /s /q package

      # Start on Node 10 because we dont test on anything lower
      - name: Install npm@7 on Node 10
        shell: bash
        if: startsWith(steps.node.outputs.node-version, 'v10.')
        id: npm-7
        run: |
          npm i --prefer-online --no-fund --no-audit -g npm@7
          echo "updated=true" >> "$GITHUB_OUTPUT"

      - name: Install npm@8 on Node 12
        shell: bash
        if: startsWith(steps.node.outputs.node-version, 'v12.')
        id: npm-8
        run: |
          npm i --prefer-online --no-fund --no-audit -g npm@8
          echo "updated=true" >> "$GITHUB_OUTPUT"

      - name: Install npm@9 on Node 14/16/18.0
        shell: bash
        if: startsWith(steps.node.outputs.node-version, 'v14.') || startsWith(steps.node.outputs.node-version, 'v16.') || startsWith(steps.node.outputs.node-version, 'v18.0.')
        id: npm-9
        run: |
          npm i --prefer-online --no-fund --no-audit -g npm@9
          echo "updated=true" >> "$GITHUB_OUTPUT"

      - name: Install npm@latest on Node
        if: ${{ !(steps.npm-7.outputs.updated || steps.npm-8.outputs.updated || steps.npm-9.outputs.updated) }}
        run: npm i --prefer-online --no-fund --no-audit -g npm@latest

      - name: npm Version
        run: npm -v
      - name: Install Dependencies
        run: npm i --ignore-scripts --no-audit --no-fund
      - name: Run Post Pull Request Actions
        env:
          RELEASE_PR_NUMBER: ${{ needs.release.outputs.pr-number }}
          RELEASE_COMMENT_ID: ${{ needs.release.outputs.comment-id }}
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: |
          npm exec --offline -- template-oss-release-manager --lockfile=false --publish=false
          npm run rp-pull-request --ignore-scripts --if-present
      - name: Commit
        id: commit
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: |
          git commit --all --amend --no-edit || true
          git push --force-with-lease
          echo "sha=$(git rev-parse HEAD)" >> $GITHUB_OUTPUT
      - name: Get Workflow Job
        uses: actions/github-script@v6
        if: steps.commit.outputs.sha
        id: check-output
        env:
          JOB_NAME: "Update - Release"
          MATRIX_NAME: ""
        with:
          script: |
            const { owner, repo } = context.repo

            const { data } = await github.rest.actions.listJobsForWorkflowRun({
              owner,
              repo,
              run_id: context.runId,
              per_page: 100
            })

            const jobName = process.env.JOB_NAME + process.env.MATRIX_NAME
            const job = data.jobs.find(j => j.name.endsWith(jobName))
            const jobUrl = job?.html_url

            const shaUrl = `${context.serverUrl}/${owner}/${repo}/commit/${{ steps.commit.outputs.sha }}`

            let summary = `This check is assosciated with ${shaUrl}\n\n`

            if (jobUrl) {
              summary += `For run logs, click here: ${jobUrl}`
            } else {
              summary += `Run logs could not be found for a job with name: "${jobName}"`
            }

            return { summary }
      - name: Create Check
        uses: LouisBrunner/checks-action@v1.6.0
        id: check
        if: steps.commit.outputs.sha
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          status: in_progress
          name: Release
          sha: ${{ steps.commit.outputs.sha }}
          output: ${{ steps.check-output.outputs.result }}
      - name: Conclude Check
        uses: LouisBrunner/checks-action@v1.6.0
        if: needs.release.outputs.check-id && always()
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          conclusion: ${{ job.status }}
          check_id: ${{ needs.release.outputs.check-id }}

  ci:
    name: CI - Release
    needs: [ release, update ]
    if: needs.release.outputs.pr
    uses: ./.github/workflows/ci-release.yml
    with:
      ref: ${{ needs.release.outputs.branch }}
      check-sha: ${{ needs.update.outputs.sha }}

  post-ci:
    needs: [ release, update, ci ]
    name: Post CI - Release
    if: github.repository_owner == 'npm' && needs.release.outputs.pr && always()
    runs-on: ubuntu-latest
    defaults:
      run:
        shell: bash
    steps:
      - name: Get Needs Result
        id: needs-result
        run: |
          result=""
          if [[ "${{ contains(needs.*.result, 'failure') }}" == "true" ]]; then
            result="failure"
          elif [[ "${{ contains(needs.*.result, 'cancelled') }}" == "true" ]]; then
            result="cancelled"
          else
            result="success"
          fi
          echo "result=$result" >> $GITHUB_OUTPUT
      - name: Conclude Check
        uses: LouisBrunner/checks-action@v1.6.0
        if: needs.update.outputs.check-id && always()
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          conclusion: ${{ steps.needs-result.outputs.result }}
          check_id: ${{ needs.update.outputs.check-id }}

  post-release:
    needs: release
    name: Post Release - Release
    if: github.repository_owner == 'npm' && needs.release.outputs.releases
    runs-on: ubuntu-latest
    defaults:
      run:
        shell: bash
    steps:
      - name: Create Release PR Comment
        uses: actions/github-script@v6
        env:
          RELEASES: ${{ needs.release.outputs.releases }}
        with:
          script: |
            const releases = JSON.parse(process.env.RELEASES)
            const { runId, repo: { owner, repo } } = context
            const issue_number = releases[0].prNumber

            let body = '## Release Workflow\n\n'
            for (const { pkgName, version, url } of releases) {
              body += `- \`${pkgName}@${version}\` ${url}\n`
            }

            const comments = await github.paginate(github.rest.issues.listComments, { owner, repo, issue_number })
              .then(cs => cs.map(c => ({ id: c.id, login: c.user.login, body: c.body })))
            console.log(`Found comments: ${JSON.stringify(comments, null, 2)}`)
            const releaseComments = comments.filter(c => c.login === 'github-actions[bot]' && c.body.includes('Release is at'))

            for (const comment of releaseComments) {
              console.log(`Release comment: ${JSON.stringify(comment, null, 2)}`)
              await github.rest.issues.deleteComment({ owner, repo, comment_id: comment.id })
            }

            const runUrl = `https://github.com/${owner}/${repo}/actions/runs/${runId}`
            await github.rest.issues.createComment({
              owner,
              repo,
              issue_number,
              body: `${body}- Workflow run: :arrows_counterclockwise: ${runUrl}`,
            })

  release-integration:
    needs: release
    name: Release Integration
    if: needs.release.outputs.release
    runs-on: ubuntu-latest
    defaults:
      run:
        shell: bash
    steps:
      - name: Setup Node
        uses: actions/setup-node@v3
        id: node
        with:
          node-version: 20.x
          check-latest: contains('20.x', '.x')

      # node 10/12/14 ship with npm@6, which is known to fail when updating itself in windows
      - name: Update Windows npm
        if: |
          matrix.platform.os == 'windows-latest' && (
            startsWith(steps.node.outputs.node-version, 'v10.') || startsWith(steps.node.outputs.node-version, 'v12.') || startsWith(steps.node.outputs.node-version, 'v14.')
          )
        run: |
          curl -sO https://registry.npmjs.org/npm/-/npm-7.5.4.tgz
          tar xf npm-7.5.4.tgz
          cd package
          node lib/npm.js install --no-fund --no-audit -g ..\npm-7.5.4.tgz
          cd ..
          rmdir /s /q package

      # Start on Node 10 because we dont test on anything lower
      - name: Install npm@7 on Node 10
        shell: bash
        if: startsWith(steps.node.outputs.node-version, 'v10.')
        id: npm-7
        run: |
          npm i --prefer-online --no-fund --no-audit -g npm@7
          echo "updated=true" >> "$GITHUB_OUTPUT"

      - name: Install npm@8 on Node 12
        shell: bash
        if: startsWith(steps.node.outputs.node-version, 'v12.')
        id: npm-8
        run: |
          npm i --prefer-online --no-fund --no-audit -g npm@8
          echo "updated=true" >> "$GITHUB_OUTPUT"

      - name: Install npm@9 on Node 14/16/18.0
        shell: bash
        if: startsWith(steps.node.outputs.node-version, 'v14.') || startsWith(steps.node.outputs.node-version, 'v16.') || startsWith(steps.node.outputs.node-version, 'v18.0.')
        id: npm-9
        run: |
          npm i --prefer-online --no-fund --no-audit -g npm@9
          echo "updated=true" >> "$GITHUB_OUTPUT"

      - name: Install npm@latest on Node
        if: ${{ !(steps.npm-7.outputs.updated || steps.npm-8.outputs.updated || steps.npm-9.outputs.updated) }}
        run: npm i --prefer-online --no-fund --no-audit -g npm@latest

      - name: npm Version
        run: npm -v
      - name: View in Registry
        run: |
          EXIT_CODE=0

          function is_published {
            if npm view "$@" --loglevel=error > /dev/null; then
              echo 0
            else
              echo 1
            fi
          }

          for release in $(echo '${{ needs.release.outputs.releases }}' | jq -r '.[] | @base64'); do
            name=$(echo "$release" | base64 --decode | jq -r .pkgName)
            version=$(echo "$release" | base64 --decode | jq -r .version)
            spec="$name@$version"
            status=$(is_published "$spec")
            if [[ "$status" -eq 1 ]]; then
              echo "$spec ERROR"
              EXIT_CODE=$status
            else
              echo "$spec OK"
            fi
          done

          exit $EXIT_CODE

  post-release-integration:
    needs: [ release, release-integration ]
    name: Post Release Integration - Release
    if: github.repository_owner == 'npm' && needs.release.outputs.release && always()
    runs-on: ubuntu-latest
    defaults:
      run:
        shell: bash
    steps:
      - name: Get Needs Result
        id: needs-result
        run: |
          if [[ "${{ contains(needs.*.result, 'failure') }}" == "true" ]]; then
            result="x"
          elif [[ "${{ contains(needs.*.result, 'cancelled') }}" == "true" ]]; then
            result="heavy_multiplication_x"
          else
            result="white_check_mark"
          fi
          echo "result=$result" >> $GITHUB_OUTPUT
      - name: Update Release PR Comment
        uses: actions/github-script@v6
        env:
          PR_NUMBER: ${{ fromJSON(needs.release.outputs.release).prNumber }}
          RESULT: ${{ steps.needs-result.outputs.result }}
        with:
          script: |
            const { PR_NUMBER: issue_number, RESULT } = process.env
            const { runId, repo: { owner, repo } } = context

            const comments = await github.paginate(github.rest.issues.listComments, { owner, repo, issue_number })
            const updateComment = comments.find(c =>
              c.user.login === 'github-actions[bot]' &&
              c.body.startsWith('## Release Workflow\n\n') &&
              c.body.includes(runId)
            )

            if (updateComment) {
              console.log('Found comment to update:', JSON.stringify(updateComment, null, 2))
              let body = updateComment.body.replace(/Workflow run: :[a-z_]+:/, `Workflow run: :${RESULT}:`)
              const tagCodeowner = RESULT !== 'white_check_mark'
              if (tagCodeowner) {
                body += `\n\n:rotating_light:`
                body += ` @npm/cli-team: The post-release workflow failed for this release.`
                body += ` Manual steps may need to be taken after examining the workflow output`
                body += ` from the above workflow run. :rotating_light:`
              }
              await github.rest.issues.updateComment({
                owner,
                repo,
                body,
                comment_id: updateComment.id,
              })
            } else {
              console.log('No matching comments found:', JSON.stringify(comments, null, 2))
            }