@npmcli/template-oss 4.21.4 → 4.22.0

package/lib/check/check-apply.js

@@ -12,8 +12,7 @@ const run = async (type, dir, files, options) => {
   const { add: addFiles, rm: rmFiles } = files
 
   const rm = await rmEach(dir, rmFiles, options, (f) => rel(f))
-  const parseOpts = { allowMultipleSources: false }
-  const [add, update] = partition(await parseEach(dir, addFiles, options, parseOpts, async (p) => {
+  const [add, update] = partition(await parseEach(dir, addFiles, options, {}, async (p) => {
     const diff = await p.applyDiff()
     const target = rel(p.target)
     if (diff === null) {

package/lib/content/LICENSE-md.hbs

@@ -7,10 +7,10 @@ software for any purpose with or without fee is hereby
 granted, provided that the above copyright notice and this
 permission notice appear in all copies.
 
-THE SOFTWARE IS PROVIDED "AS IS" AND NPM DISCLAIMS ALL
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
 WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO
-EVENT SHALL NPM BE LIABLE FOR ANY SPECIAL, DIRECT,
+EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
 INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER

package/lib/content/_job-matrix-yml.hbs

@@ -11,6 +11,9 @@ strategy:
       - name: macOS
         os: macos-latest
         shell: bash
+      - name: macOS
+        os: macos-13
+        shell: bash
       {{/if}}
       {{#if windowsCI}}
       - name: Windows
@@ -21,6 +24,13 @@ strategy:
       {{#each ciVersions}}
       - {{ . }}
       {{/each}}
+    {{#if macCI}}
+    exclude:
+      {{#each ciVersions}}
+      - platform: {name: macOS, os: macos-{{#if (lte (semverRangeMajor .) 14)}}latest{{else}}13{{/if}}, shell: bash}
+        node-version: {{ . }}
+      {{/each}}
+    {{/if}}
 runs-on: $\{{ matrix.platform.os }}
 defaults:
   run:

package/lib/content/_job-release-integration-yml.hbs

@@ -23,22 +23,15 @@ steps:
     run: |
       EXIT_CODE=0
 
-      function each_release {
-        if {{#if publish}}npm publish --provenance --tag="$1"{{else}}npm view "$@" --loglevel=error > /dev/null{{/if}}; then
-          echo 0
-        else
-          echo 1
-        fi
-      }
-
       for release in $(echo $RELEASES | jq -r '.[] | @base64'); do
         {{#if publish}}
         PUBLISH_TAG=$(echo "$release" | base64 --decode | jq -r .publishTag)
-        STATUS=$(each_release "$PUBLISH_TAG")
+        npm publish --provenance --tag="$PUBLISH_TAG"
         {{else}}
         SPEC="$(echo "$release" | base64 --decode | jq -r .pkgName)@$(echo "$release" | base64 --decode | jq -r .version)"
-        STATUS=$(each_release "$SPEC")
+        npm view "$SPEC" --json
         {{/if}}
+        STATUS=$?
         if [[ "$STATUS" -eq 1 ]]; then
           EXIT_CODE=$STATUS
         {{#unless publish}}

package/lib/content/_step-git-yml.hbs

@@ -1,5 +1,5 @@
 - name: Checkout
-  uses: actions/checkout@v3
+  uses: actions/checkout@v4
   {{#if jobCheckout}}
   with:
   {{#each jobCheckout}}

package/lib/content/_step-node-yml.hbs

@@ -1,5 +1,5 @@
 - name: Setup Node
-  uses: actions/setup-node@v3
+  uses: actions/setup-node@v4
   id: node
   with:
     node-version: {{#if jobIsMatrix}}$\{{ matrix.node-version }}{{else}}{{ last ciVersions }}{{/if}}

package/lib/content/action-create-check-yml.hbs

@@ -15,7 +15,7 @@ runs:
   using: "composite"
   steps:
     - name: Get Workflow Job
-      uses: actions/github-script@v6
+      uses: actions/github-script@v7
       id: workflow
       env:
         JOB_NAME: "$\{{ inputs.name }}"

package/lib/content/index.js

@@ -172,7 +172,7 @@ module.exports = {
     /* to be provided by consuming package */
   ],
   ciVersions: {},
-  latestCiVersion: 20,
+  latestCiVersion: 22,
   lockfile: false,
   codeowner: '@npm/cli-team',
   eslint: true,
@@ -199,10 +199,10 @@ module.exports = {
   },
   allowedPackages: [],
   changelogTypes: [
-    { type: 'feat', section: 'Features', hidden: false, collapse: false },
-    { type: 'fix', section: 'Bug Fixes', hidden: false, collapse: false },
-    { type: 'docs', section: 'Documentation', hidden: false, collapse: false },
-    { type: 'deps', section: 'Dependencies', hidden: false, collapse: false },
-    { type: 'chore', section: 'Chores', hidden: false, collapse: false },
+    { type: 'feat', section: 'Features', hidden: false },
+    { type: 'fix', section: 'Bug Fixes', hidden: false },
+    { type: 'docs', section: 'Documentation', hidden: false },
+    { type: 'deps', section: 'Dependencies', hidden: false },
+    { type: 'chore', section: 'Chores', hidden: true },
   ],
 }

package/lib/content/release-yml.hbs

@@ -30,7 +30,7 @@ jobs:
         run: {{ rootNpxPath }} --offline template-oss-release-please --branch="$\{{ github.ref_name }}" --backport="{{ backport }}" --defaultTag="{{ defaultPublishTag }}"
       - name: Create Release Manager Comment Text
         if: steps.release.outputs.pr-number
-        uses: actions/github-script@v6
+        uses: actions/github-script@v7
         id: comment-text
         with:
           result-encoding: string
@@ -156,7 +156,7 @@ jobs:
     {{> jobYml jobName="Post Release - Release" jobIf="needs.release.outputs.releases" jobSkipSetup=true  }}
       - name: Create Release PR Comment Text
         id: comment-text
-        uses: actions/github-script@v6
+        uses: actions/github-script@v7
         env:
           RELEASES: $\{{ needs.release.outputs.releases }}
         with:
@@ -217,7 +217,7 @@ jobs:
       - name: Create Release PR Comment Text
         id: comment-text
         if: steps.found-comment.outputs.comment-id
-        uses: actions/github-script@v6
+        uses: actions/github-script@v7
         env:
           RESULT: $\{{ steps.conclusion.outputs.result }}
           BODY: $\{{ steps.found-comment.outputs.comment-body }}

package/lib/release/changelog.js

@@ -29,28 +29,28 @@ class Changelog {
   }
 
   #getEntries (type) {
-    const section = this.#sections[type]
-    const entries = this.#entries[type].map(list)
-    // Ignoring coverage until we use this again
-    /* istanbul ignore next */
-    if (section?.collapse) {
-      entries.unshift('<details><summary>Commits</summary>\n')
-      entries.push('\n</details>')
-    }
-    return entries.join('\n')
+    return this.#entries[type].map(list).join('\n')
   }
 
   toString () {
     const body = [this.#title]
+    const includedTypes = []
+
     for (const type of this.#types) {
-      const title = this.#titles[type]
       if (this.#entries[type]?.length) {
-        body.push(
-          `### ${title}`,
-          this.#getEntries(type)
-        )
+        includedTypes.push(type)
+        body.push(`### ${this.#titles[type]}`, this.#getEntries(type))
       }
     }
+
+    // If every commit is from a hidden section then we return an
+    // empty string which will skip the release PR being created.
+    // We do this because we don't want PRs opened if they only contain
+    // chores but we do want to rebuild existing PRs if chores are added.
+    if (includedTypes.every((type) => this.#sections[type]?.hidden)) {
+      return ''
+    }
+
     return body.join('\n\n').trim()
   }
 }

package/lib/release/node-workspace-format.js

@@ -3,7 +3,7 @@ const { ManifestPlugin } = require('release-please/build/src/plugin.js')
 const { addPath } = require('release-please/build/src/plugins/workspace.js')
 const { TagName } = require('release-please/build/src/util/tag-name.js')
 const { ROOT_PROJECT_PATH } = require('release-please/build/src/manifest.js')
-const { DEPS, link, wrapSpecs } = require('./util.js')
+const { DEPS, link, wrapSpecs, list } = require('./util.js')
 
 /* istanbul ignore next: TODO fix flaky tests and enable coverage */
 module.exports = class extends ManifestPlugin {
@@ -11,7 +11,6 @@ module.exports = class extends ManifestPlugin {
 
   #releasesByPackage = new Map()
   #pathsByComponent = new Map()
-  #WORKSPACE_SCOPE = /(?<scope>workspace): `?(?<name>\S+?)[@\s](?<version>\S+?)`?$/gm
 
   async preconfigure (strategiesByPath) {
     // First build a list of all releases that will happen based on
@@ -32,6 +31,16 @@ module.exports = class extends ManifestPlugin {
     return candidates
   }
 
+  #replaceWorkspace ({ name, versionRange }) {
+    const version = versionRange.replace(/^[\^~]/, '')
+    const { path, component } = this.#releasesByPackage.get(name)
+    const { tagSeparator, includeVInTag } = this.repositoryConfig[path]
+    const { repository: { owner, repo } } = this.github
+    const tag = new TagName(version, component, tagSeparator, includeVInTag).toString()
+    const url = `https://github.com/${owner}/${repo}/releases/tag/${tag}`
+    return list(`${link('workspace', url)}: ${wrapSpecs(`${name}@${version}`)}`)
+  }
+
   // I don't like how release-please formats workspace changelog entries
   // so this rewrites them to look like the rest of our changelog. This can't
   // be part of the changelog plugin since they are written after that by the
@@ -42,16 +51,20 @@ module.exports = class extends ManifestPlugin {
       for (const release of candidate.pullRequest.body.releaseData) {
         // Update notes with a link to each workspaces release notes
         // now that we have all of the releases in a single pull request
-        release.notes =
-          release.notes.replace(this.#WORKSPACE_SCOPE, (...args) => {
-            const { scope, name, version } = args.pop()
-            const { path, component } = this.#releasesByPackage.get(name)
-            const { tagSeparator, includeVInTag } = this.repositoryConfig[path]
-            const { repository: { owner, repo } } = this.github
-            const tag = new TagName(version, component, tagSeparator, includeVInTag).toString()
-            const url = `https://github.com/${owner}/${repo}/releases/tag/${tag}`
-            return `${link(scope, url)}: ${wrapSpecs(`${name}@${version}`)}`
-          })
+        release.notes = release.notes
+          .replace(/^\* The following workspace dependencies were updated\n/gm, '')
+          .replace(/^\s{2}\* dependencies\n/gm, '')
+          .replace(/^\s{2}\* devDependencies\n/gm, '')
+          .replace(/^\s{2}\* peerDependencies\n/gm, '')
+          .replace(/^\s{2}\* optionalDependencies\n/gm, '')
+          .replace(
+            /^\s{4}\* (?<name>[^\s]+) bumped to (?<versionRange>[^\s]+)/gm,
+            (...args) => this.#replaceWorkspace(args.at(-1))
+          )
+          .replace(
+            /^\s{4}\* (?<name>[^\s]+) bumped from (?:[^\s]+) to (?<versionRange>[^\s]+)/gm,
+            (...args) => this.#replaceWorkspace(args.at(-1))
+          )
 
         // Find the associated changelog and update that too
         const path = this.#pathsByComponent.get(release.component)

package/lib/release/release-please.js

@@ -11,7 +11,6 @@ const assert = require('assert')
 const core = require('@actions/core')
 const omit = require('just-omit')
 const ChangelogNotes = require('./changelog.js')
-const NodeWorkspace = require('./node-workspace.js')
 const NodeWorkspaceFormat = require('./node-workspace-format.js')
 const { getPublishTag, noop } = require('./util.js')
 
@@ -69,8 +68,6 @@ class ReleasePlease {
       new ChangelogNotes(github, o))
     RP.registerVersioningStrategy('default', (o) =>
       o.prerelease ? new PrereleaseVersioningStrategy(o) : new DefaultVersioningStrategy(o))
-    RP.registerPlugin('node-workspace', ({ github, targetBranch, repositoryConfig, ...o }) =>
-      new NodeWorkspace(github, targetBranch, repositoryConfig, o))
     RP.registerPlugin('node-workspace-format', ({ github, targetBranch, repositoryConfig, ...o }) =>
       new NodeWorkspaceFormat(github, targetBranch, repositoryConfig, o))
 

package/lib/util/files.js

@@ -31,29 +31,28 @@ const mergeFiles = mergeWithCustomizers((value, srcValue, key, target, source, s
   }
 }, customizers.overwriteArrays)
 
-const fileEntries = (dir, files, options, { allowMultipleSources = true } = {}) => {
+const fileEntries = (dir, files, options) => {
   const results = []
 
-  for (const [key, source] of Object.entries(files)) {
+  for (const [key, value] of Object.entries(files)) {
     // remove any false values first since that means those targets are skipped
-    if (source === false) {
+    if (value === false) {
       continue
     }
 
     // target paths need to be joined with dir and templated
     const target = join(dir, template(key, options))
 
-    if (Array.isArray(source)) {
-      // When turning an object of files into all its entries, we allow
-      // multiples when applying changes, but not when checking for changes
-      // since earlier files would always return as needing an update. So we
-      // either allow multiples and return the array or only return the last
-      // source file in the array.
-      const sources = allowMultipleSources ? source : source.slice(-1)
-      results.push(...sources.map(s => [target, s]))
-    } else {
-      results.push([target, source])
-    }
+    // Allow an array of values to merge into a single source to be
+    // applied or diffed against the target. This is how overwrite:false
+    // works and they are merged.
+    const source = Array.isArray(value)
+      ? value.reduce((acc, { file, ...rest }) => {
+        acc.file.push(file)
+        return Object.assign(acc, rest)
+      }, { file: [] }) : value
+
+    results.push([target, source])
   }
 
   return results

package/lib/util/git.js

@@ -23,7 +23,7 @@ const getRemoteUrl = async (path, remote) => {
   try {
     const urlStr = await tryGit(path, 'remote', 'get-url', remote)
     const { domain, user, project } = hgi.fromUrl(urlStr)
-    const url = new URL(`https://${domain}`)
+    const url = new URL(`git+https://${domain}`)
     url.pathname = `/${user}/${project}.git`
     return url.toString()
   } catch {

package/lib/util/parser.js

@@ -62,10 +62,16 @@ class Base {
   }
 
   read (s) {
+    if (Array.isArray(s)) {
+      return Promise.all(s.map(f => this.read(f)))
+    }
     return fs.readFile(s, { encoding: 'utf-8' })
   }
 
   template (s) {
+    if (Array.isArray(s)) {
+      return Promise.all(s.map(f => this.template(f)))
+    }
     return template(s, this.options)
   }
 
@@ -285,6 +291,9 @@ class Json extends Base {
   }
 
   parse (s) {
+    if (Array.isArray(s)) {
+      return s.map(f => this.parse(f)).reduce((a, f) => this.merge(a, f), {})
+    }
     return jsonParse(s)
   }
 

package/lib/util/template.js

@@ -1,5 +1,6 @@
 const Handlebars = require('handlebars')
 const { basename, extname, join } = require('path')
+const { Range } = require('semver')
 const fs = require('fs')
 const DELETE = '__DELETE__'
 
@@ -39,6 +40,8 @@ const setupHandlebars = (dirs) => {
   Handlebars.registerHelper('last', (arr) => arr[arr.length - 1])
   Handlebars.registerHelper('json', (c) => JSON.stringify(c))
   Handlebars.registerHelper('del', () => JSON.stringify(DELETE))
+  Handlebars.registerHelper('semverRangeMajor', (v) => new Range(v).set[0][0].semver.major)
+  Handlebars.registerHelper('lte', (a, b) => a <= b)
 
   if (Array.isArray(dirs)) {
     const [baseDir, ...otherDirs] = dirs

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@npmcli/template-oss",
-  "version": "4.21.4",
+  "version": "4.22.0",
   "description": "templated files used in npm CLI team oss projects",
   "main": "lib/content/index.js",
   "bin": {
@@ -24,7 +24,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/npm/template-oss.git"
+    "url": "git+https://github.com/npm/template-oss.git"
   },
   "keywords": [
     "npm",
@@ -56,7 +56,7 @@
     "minimatch": "^9.0.2",
     "npm-package-arg": "^11.0.1",
     "proc-log": "^4.0.0",
-    "release-please": "16.3.1",
+    "release-please": "16.10.2",
     "semver": "^7.3.5",
     "undici": "^6.7.0",
     "yaml": "^2.1.1"

package/lib/release/node-workspace.js

@@ -1,103 +0,0 @@
-const { NodeWorkspace } = require('release-please/build/src/plugins/node-workspace')
-const { parseConventionalCommits } = require('release-please/build/src/commit')
-const { DEPS } = require('./util')
-const { WORKSPACE_MESSAGE } = require('./node-workspace-format')
-
-// This adds a preconfigure method to the release-please node-workspace plugin
-// which fixes https://github.com/googleapis/release-please/issues/2089 for our
-// use case. We should attempt to upstream this to release-please but it
-// fundamentally changes the way the node-workspace plugin behaves so it might
-// not be easy to land. For now we extend the base plugin and add one method
-// which is much better than previously when we needed to fork and maintain
-// release-please ourselves.
-/* istanbul ignore next: TODO fix flaky tests and enable coverage */
-class NpmNodeWorkspace extends NodeWorkspace {
-  updateCandidate (pr) {
-    // no-op so release-please node-workspace plugin does not add
-    // its broken changelog to the workspace releases. our changelog
-    // formatting and the preconfigure method below fix this.
-    return pr
-  }
-
-  async preconfigure (strategiesByPath, commitsByPath, releasesByPath) {
-    // First build a list of all releases that will happen based on the
-    // conventional commits
-    const candidates = []
-    for (const path in strategiesByPath) {
-      const pullRequest = await strategiesByPath[path].buildReleasePullRequest(
-        parseConventionalCommits(commitsByPath[path]),
-        releasesByPath[path]
-      )
-      // Release please types say this sometimes will return undefined but I could not
-      // get any scenario where that was the case. If it was undefined we would want to
-      // just ignore it anyway.
-      /* istanbul ignore else */
-      if (pullRequest) {
-        candidates.push({
-          path,
-          pullRequest,
-          config: this.repositoryConfig[path],
-        })
-      }
-    }
-
-    // Then build the graph of all those releases + any other connected workspaces
-    const { allPackages, candidatesByPackage } = await this.buildAllPackages(candidates)
-    const graph = await this.buildGraph(allPackages)
-    const packageNamesToUpdate = this.packageNamesToUpdate(graph, candidatesByPackage)
-    const graphPackages = this.buildGraphOrder(graph, packageNamesToUpdate)
-
-    // Then build a list of all the updated versions
-    const updatedVersions = {}
-    for (const pkg of graphPackages) {
-      const path = this.pathFromPackage(pkg)
-      const packageName = this.packageNameFromPackage(pkg)
-      const existingCandidate = candidatesByPackage[packageName]
-
-      if (existingCandidate) {
-        // If there is an existing pull request use that version
-        updatedVersions[packageName] = existingCandidate.pullRequest?.version
-      } else {
-        // Otherwise build another pull request (that will be discarded) just
-        // to see what the version would be if it only contained a deps commit.
-        // This is to make sure we use any custom versioning or release strategy.
-        const releasePullRequest = await strategiesByPath[path].buildReleasePullRequest(
-          parseConventionalCommits([{ message: `${DEPS}: ${Math.random()}` }]),
-          releasesByPath[path]
-        )
-        updatedVersions[packageName] = releasePullRequest?.version
-      }
-    }
-
-    // Then go through all the packages again and add deps commits for each
-    // updated workspace
-    for (const pkg of graphPackages) {
-      const path = this.pathFromPackage(pkg)
-      const packageName = this.packageNameFromPackage(pkg)
-      const graphPackage = graph.get(packageName)
-
-      // Update dependency versions add a deps commit to each path so it gets
-      // processed later. This else never happens in our cases because our
-      // packages always have deps, but keeping this around to make it easier to
-      // upstream in the future.
-      /* istanbul ignore else */
-      if (graphPackage.deps) {
-        for (const depName of graphPackage.deps) {
-          const depVersion = updatedVersions[depName]
-          // Same as the above check, we always have a version here but technically
-          // we could not in which it would be safe to ignore it.
-          /* istanbul ignore else */
-          if (depVersion) {
-            commitsByPath[path].push({
-              message: WORKSPACE_MESSAGE(depName, depVersion.toString()),
-            })
-          }
-        }
-      }
-    }
-
-    return strategiesByPath
-  }
-}
-
-module.exports = NpmNodeWorkspace