@npmcli/template-oss 4.5.0 → 4.6.0

package/bin/release-please.js

@@ -4,7 +4,7 @@ const core = require('@actions/core')
 const main = require('../lib/release-please/index.js')
 
 const dryRun = !process.env.CI
-const [branch] = process.argv.slice(2)
+const [branch, eventName] = process.argv.slice(2)
 
 const debugPr = (val) => {
   if (dryRun) {
@@ -33,6 +33,7 @@ main({
   repo: process.env.GITHUB_REPOSITORY,
   dryRun,
   branch,
+  force: eventName === 'workflow_dispatch',
 }).then(({ pr, release, releases }) => {
   if (pr) {
     debugPr(pr)

package/lib/apply/apply-files.js

@@ -1,4 +1,4 @@
-const fs = require('@npmcli/fs')
+const fs = require('fs/promises')
 const log = require('proc-log')
 const { rmEach, parseEach } = require('../util/files.js')
 

package/lib/check/check-changelog.js

@@ -1,4 +1,5 @@
-const fs = require('@npmcli/fs')
+const fs = require('fs/promises')
+const { existsSync } = require('fs')
 const { join, relative } = require('path')
 
 const run = async ({ root, path }) => {
@@ -7,7 +8,7 @@ const run = async ({ root, path }) => {
   // make this glob for possible matches
   const changelog = join(path, 'CHANGELOG.md')
 
-  if (await fs.exists(changelog)) {
+  if (existsSync(changelog)) {
     const content = await fs.readFile(changelog, { encoding: 'utf8' })
     const mustStart = /^#\s+Changelog\r?\n\r?\n#/
     if (!mustStart.test(content)) {

package/lib/check/check-gitignore.js

@@ -1,6 +1,7 @@
 const log = require('proc-log')
 const { resolve, relative, basename } = require('path')
-const fs = require('@npmcli/fs')
+const fs = require('fs/promises')
+const { existsSync } = require('fs')
 const git = require('@npmcli/git')
 
 const NAME = 'check-gitignore'
@@ -17,7 +18,7 @@ const run = async ({ root, path, config }) => {
   // use the root to detect a git repo but the project directory (path) for the
   // ignore check
   const ignoreFile = resolve(path, '.gitignore')
-  if (!await git.is({ cwd: root }) || !await fs.exists(ignoreFile)) {
+  if (!await git.is({ cwd: root }) || !existsSync(ignoreFile)) {
     log.verbose(NAME, 'no git or no gitignore')
     return null
   }

package/lib/config.js

@@ -99,6 +99,10 @@ const getFullConfig = async ({
   pkgConfig: _pkgConfig,
 }) => {
   const isRoot = root === path
+  const isWorkspace = !isRoot
+  const isMono = !!workspaces.length
+  const isRootMono = isRoot && isMono
+
   const isLatest = _pkgConfig.version === LATEST_VERSION
   const isDogFood = pkgJson.name === NAME
   const isForce = process.argv.includes('--force')
@@ -154,14 +158,14 @@ const getFullConfig = async ({
   // all derived keys
   const derived = {
     isRoot,
-    isWorkspace: !isRoot,
+    isWorkspace,
     // Some files are written to the base of a repo but will
     // include configuration for all packages within a monorepo
     // For these cases it is helpful to know if we are in a
     // monorepo since template-oss might be used only for
     // workspaces and not the root or vice versa.
-    isRootMono: isRoot && !!workspaces.length,
-    isMono: !!workspaces.length,
+    isRootMono,
+    isMono,
     // repo
     repoDir: root,
     repoFiles,
@@ -177,8 +181,8 @@ const getFullConfig = async ({
     pkgPath,
     pkgDir: posixDir(pkgPath),
     pkgGlob: posixGlob(pkgPath),
-    pkgFlags: isRoot ? '-iwr' : `-w ${pkgJson.name}`,
-    allFlags: `${workspaces.length ? '-ws -iwr' : ''} --if-present`.trim(),
+    pkgFlags: isWorkspace ? `-w ${pkgJson.name}` : '',
+    allFlags: isMono ? '-ws -iwr --if-present' : '',
     workspacePaths,
     workspaceGlobs: workspacePaths.map(posixGlob),
     // booleans to control application of updates

package/lib/content/_step-audit.yml

@@ -0,0 +1,2 @@
+- name: Run Audit
+  run: {{ rootNpmPath }} audit

package/lib/content/_step-checks.yml

@@ -1,3 +1,38 @@
+{{#if jobCheck.sha}}
+- name: Get Workflow Job
+  uses: actions/github-script@v6
+  {{#if jobCheck.if}}if: {{ jobCheck.if }}{{/if}}
+  id: check-output
+  env:
+    JOB_NAME: "{{#if jobName}}{{ jobName }}{{else}}{{ jobCheck.name }}{{/if}}"
+    MATRIX_NAME: "{{#if jobIsMatrix}} - $\{{ matrix.platform.name }} - $\{{ matrix.node-version }}{{/if}}"
+  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/{{ jobCheck.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 }
+{{/if}}
 - name: {{#if jobCheck.sha}}Create{{else}}Conclude{{/if}} Check
   uses: LouisBrunner/checks-action@v1.3.1
   {{#if jobCheck.sha}}
@@ -12,12 +47,7 @@
     status: {{#if jobCheck.status}}{{ jobCheck.status }}{{else}}in_progress{{/if}} 
     name: {{#if jobCheck.name}}{{ jobCheck.name }}{{else}}{{ jobName }}{{/if}}{{#if jobIsMatrix}} - $\{{ matrix.platform.name }} - $\{{ matrix.node-version }}{{/if}}
     sha: {{ jobCheck.sha }}
-    # XXX: this does not work when using the default GITHUB_TOKEN.
-    # Instead we post the main job url to the PR as a comment which
-    # will link to all the other checks. To work around this we would
-    # need to create a GitHub that would create on-demand tokens.
-    # https://github.com/LouisBrunner/checks-action/issues/18
-    # details_url:
+    output: $\{{ steps.check-output.outputs.result }}
     {{else}}
     conclusion: {{#if jobCheck.status}}{{ jobCheck.status }}{{else}}$\{{ job.status }}{{/if}}
     check_id: {{#if jobCheck.id}}{{ jobCheck.id }}{{else}}$\{{ steps.check.outputs.check_id }}{{/if}}

package/lib/content/_step-lint.yml

@@ -1,4 +1,4 @@
 - name: Lint
-  run: {{ rootNpmPath }} run lint --ignore-scripts
+  run: {{ rootNpmPath }} run lint --ignore-scripts {{~#if jobRunFlags}} {{ jobRunFlags }}{{/if}}
 - name: Post Lint
-  run: {{ rootNpmPath }} run postlint --ignore-scripts
+  run: {{ rootNpmPath }} run postlint --ignore-scripts {{~#if jobRunFlags}} {{ jobRunFlags }}{{/if}}

package/lib/content/audit.yml

@@ -9,5 +9,4 @@ on:
 jobs:
   audit:
     {{> job jobName="Audit Dependencies" jobDepFlags="--package-lock" }}
-      - name: Run Audit
-        run: {{ rootNpmPath }} audit
+      {{> stepAudit }}

package/lib/content/release.yml

@@ -1,6 +1,7 @@
 name: Release
 
 on:
+  workflow_dispatch:
   push:
     branches:
       {{#each branches}}
@@ -31,17 +32,19 @@ jobs:
         env:
           GITHUB_TOKEN: $\{{ secrets.GITHUB_TOKEN }}
         run: |
-          {{ rootNpxPath }} --offline template-oss-release-please $\{{ github.ref_name }}
+          {{ rootNpxPath }} --offline template-oss-release-please $\{{ github.ref_name }} $\{{ github.event_name }}
       - 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 } = process.env
             const repo = { owner: context.repo.owner, repo: context.repo.repo }
-            const issue = { ...repo, issue_number: process.env.PR_NUMBER }
+            const issue = { ...repo, issue_number: PR_NUMBER }
 
             const { data: workflow } = await github.rest.actions.getWorkflowRun({ ...repo, run_id: context.runId })
 
@@ -50,7 +53,11 @@ jobs:
             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
 
-            body += `- Release workflow run: ${workflow.html_url}`
+            body += `Release workflow run: ${workflow.html_url}\n\n#### Force CI to Rerun for 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 rerun, run this command:\n\n`
+            body += `\`\`\`\ngh workflow run release.yml -r ${REF_NAME}\n\`\`\``
+
             if (commentId) {
               await github.rest.issues.updateComment({ ...repo, comment_id: commentId, body })
             } else {
@@ -78,7 +85,7 @@ jobs:
           GITHUB_TOKEN: $\{{ secrets.GITHUB_TOKEN }}
         run: |
           {{ rootNpmPath }} exec --offline -- template-oss-release-manager
-          {{ rootNpmPath }} run rp-pull-request --ignore-scripts {{ allFlags }}
+          {{ rootNpmPath }} run rp-pull-request --ignore-scripts {{~#if allFlags}} {{ allFlags }}{{else}} --if-present{{/if}}
       - name: Commit
         id: commit
         env:
@@ -87,7 +94,7 @@ jobs:
           git commit --all --amend --no-edit || true
           git push --force-with-lease
           echo "::set-output  name=sha::$(git rev-parse HEAD)"
-      {{> stepChecks jobCheck=(obj sha="${{ steps.commit.outputs.sha }}" name="Release" )}}
+      {{> stepChecks jobName="Update - Release" jobCheck=(obj sha="${{ steps.commit.outputs.sha }}" name="Release" )}}
       {{> stepChecks jobCheck=(obj id="${{ needs.release.outputs.check-id }}" )}}
 
   ci:

package/lib/release-please/index.js

@@ -9,7 +9,7 @@ RP.registerChangelogNotes('default', (o) => new ChangelogNotes(o))
 RP.registerVersioningStrategy('default', (o) => new Version(o))
 RP.registerPlugin('node-workspace', (o) => new NodeWs(o.github, o.targetBranch, o.repositoryConfig))
 
-const main = async ({ repo: fullRepo, token, dryRun, branch }) => {
+const main = async ({ repo: fullRepo, token, dryRun, branch, force }) => {
   if (!token) {
     throw new Error('Token is required')
   }
@@ -37,11 +37,36 @@ const main = async ({ repo: fullRepo, token, dryRun, branch }) => {
     Object.fromEntries(manifestOverrides)
   )
 
-  const pullRequests = await (dryRun ? manifest.buildPullRequests() : manifest.createPullRequests())
-  const allReleases = await (dryRun ? manifest.buildReleases() : manifest.createReleases())
+  let pullRequests = []
+  let allReleases = []
+  if (force) {
+    // If we are forcing the release CI to run again, then we get
+    // the release PR from the repo and return it, which will trigger
+    // the rest of the steps in the workflow to run
+    const prNumber = await github.octokit.issues.listForRepo({
+      owner,
+      repo,
+      labels: 'autorelease: pending',
+      per_page: 1,
+    }).then(res => res.data[0]?.number)
+    if (prNumber) {
+      pullRequests = await github.octokit.pulls.get({
+        owner,
+        repo,
+        pull_number: prNumber,
+      }).then(res => [{
+        ...res.data,
+        headBranchName: res.data.head.ref,
+        updates: [],
+      }])
+    }
+  } else {
+    pullRequests = await (dryRun ? manifest.buildPullRequests() : manifest.createPullRequests())
+    allReleases = await (dryRun ? manifest.buildReleases() : manifest.createReleases())
+  }
 
   // We only ever get a single pull request with our current release-please settings
-  const rootPr = pullRequests.filter(Boolean)[0]
+  const rootPr = pullRequests.filter(Boolean)?.[0]
   if (rootPr?.number) {
     const commits = await github.octokit.paginate(github.octokit.rest.pulls.listCommits, {
       owner: github.repository.owner,

package/lib/util/has-package.js

@@ -1,7 +1,7 @@
 const semver = require('semver')
 const npa = require('npm-package-arg')
 const { has } = require('lodash')
-const { join } = require('path')
+const { join, extname } = require('path')
 const { name: NAME } = require('../../package.json')
 
 const installLocations = [
@@ -31,6 +31,10 @@ const getSpecVersion = (spec, where) => {
       const pkg = require(join(arg.fetchSpec, 'package.json'))
       return new semver.SemVer(pkg.version)
     }
+    case 'file': {
+      // allows this repo to be installed as a tarball for testing
+      return extname(arg.fetchSpec) === '.tgz'
+    }
     case 'git': {
       // allow installing only this project from git to test in other projects
       return arg.name === NAME

package/lib/util/parser.js

@@ -1,4 +1,4 @@
-const fs = require('@npmcli/fs')
+const fs = require('fs/promises')
 const { basename, extname, dirname } = require('path')
 const yaml = require('yaml')
 const NpmPackageJson = require('@npmcli/package-json')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@npmcli/template-oss",
-  "version": "4.5.0",
+  "version": "4.6.0",
   "description": "templated files used in npm CLI team oss projects",
   "main": "lib/content/index.js",
   "bin": {
@@ -34,22 +34,21 @@
     "@commitlint/cli": "^17.1.1",
     "@commitlint/config-conventional": "^17.1.0",
     "@isaacs/string-locale-compare": "^1.1.0",
-    "@npmcli/fs": "^2.0.1",
-    "@npmcli/git": "^3.0.0",
-    "@npmcli/map-workspaces": "^2.0.2",
-    "@npmcli/package-json": "^2.0.0",
+    "@npmcli/git": "^4.0.0",
+    "@npmcli/map-workspaces": "^3.0.0",
+    "@npmcli/package-json": "^3.0.0",
     "@octokit/rest": "^19.0.4",
     "diff": "^5.0.0",
     "glob": "^8.0.1",
     "handlebars": "^4.7.7",
-    "hosted-git-info": "^5.0.0",
-    "json-parse-even-better-errors": "^2.3.1",
+    "hosted-git-info": "^6.0.0",
+    "json-parse-even-better-errors": "^3.0.0",
     "just-deep-map-values": "^1.1.1",
     "just-diff": "^5.0.1",
     "lodash": "^4.17.21",
     "npm-package-arg": "^9.0.1",
-    "proc-log": "^2.0.0",
-    "release-please": "npm:@npmcli/release-please@^14.2.5",
+    "proc-log": "^3.0.0",
+    "release-please": "npm:@npmcli/release-please@^14.2.6",
     "semver": "^7.3.5",
     "yaml": "^2.1.1"
   },
@@ -58,7 +57,7 @@
     "lib/"
   ],
   "devDependencies": {
-    "@npmcli/eslint-config": "^3.0.1",
+    "@npmcli/eslint-config": "^4.0.0",
     "@npmcli/template-oss": "file:./",
     "tap": "^16.0.0"
   },