chore: postinstall for dependabot template-oss PR

Author: lukekarrys

.github/workflows/pull-request.yml

@@ -41,8 +41,8 @@ jobs:
  id: commit
  continue-on-error: true
  run: |
- npx --offline commitlint -V --from origin/${{ github.base_ref }} --to ${{ github.event.pull_request.head.sha }}
+ npx --offline commitlint -V --from 'origin/${{ github.base_ref }}' --to ${{ github.event.pull_request.head.sha }}
  - name: Run Commitlint on PR Title
  if: steps.commit.outcome == 'failure'
  run: |
- echo ${{ github.event.pull_request.title }} | npx --offline commitlint -V
+ echo '${{ github.event.pull_request.title }}' | npx --offline commitlint -V

.github/workflows/release.yml

@@ -19,8 +19,8 @@ jobs:
  release:
  outputs:
  pr: ${{ steps.release.outputs.pr }}
+ release: ${{ steps.release.outputs.release }}
  releases: ${{ steps.release.outputs.releases }}
- release-flags: ${{ steps.release.outputs.release-flags }}
  branch: ${{ steps.release.outputs.pr-branch }}
  pr-number: ${{ steps.release.outputs.pr-number }}
  comment-id: ${{ steps.pr-comment.outputs.result }}
@@ -63,26 +63,25 @@ jobs:
  REF_NAME: ${{ github.ref_name }}
  with:
  script: |
- const { REF_NAME, PR_NUMBER } = process.env
- const repo = { owner: context.repo.owner, repo: context.repo.repo }
- const issue = { ...repo, issue_number: PR_NUMBER }
+ const { REF_NAME, PR_NUMBER: issue_number } = process.env
+ const { runId, repo: { owner, repo } } = context
 
- const { data: workflow } = await github.rest.actions.getWorkflowRun({ ...repo, run_id: context.runId })
+ 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, issue)
- let commentId = comments?.find(c => c.user.login === 'github-actions[bot]' && c.body.startsWith(body))?.id
+ 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 \`main\`. `
  body += `To force CI to update this PR, run this command:\n\n`
- body += `\`\`\`\ngh workflow run release.yml -r ${REF_NAME}\n\`\`\``
+ body += `\`\`\`\ngh workflow run release.yml -r ${REF_NAME} -R ${owner}/${repo}\n\`\`\``
 
  if (commentId) {
- await github.rest.issues.updateComment({ ...repo, comment_id: commentId, body })
+ await github.rest.issues.updateComment({ owner, repo, comment_id: commentId, body })
  } else {
- const { data: comment } = await github.rest.issues.createComment({ ...issue, body })
+ const { data: comment } = await github.rest.issues.createComment({ owner, repo, issue_number, body })
  commentId = comment?.id
  }
 
@@ -276,12 +275,45 @@ jobs:
  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: 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 })
+ const releaseComments = comments.filter(c => c.user.login === 'github-actions[bot]' && c.body.includes('Release is at'))
+
+ for (const comment of releaseComments) {
+ 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
  with:
@@ -290,10 +322,82 @@ jobs:
  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 Release Actions
- env:
- RELEASES: ${{ needs.release.outputs.releases }}
+ - 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: |
- npm run rp-release --ignore-scripts --if-present ${{ join(fromJSON(needs.release.outputs.release-flags), ' ') }}
+ result=""
+ 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 "::set-output name=result::$result"
+ - 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 { 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'))
+
+ 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}:`)
+ if (RESULT === 'x') {
+ 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))
+ }

package.json

@@ -45,6 +45,6 @@
  },
  "templateOSS": {
  "//@npmcli/template-oss": "This file is partially managed by @npmcli/template-oss. Edits may be overwritten.",
- "version": "4.11.0"
+ "version": "4.11.3"
  }
 }