@npmcli/template-oss 4.21.3 → 4.21.4

package/lib/apply/apply-files.js

@@ -1,5 +1,5 @@
 const fs = require('fs/promises')
-const log = require('proc-log')
+const { log } = require('proc-log')
 const { rmEach, parseEach } = require('../util/files.js')
 
 const run = async (dir, files, options) => {

package/lib/apply/apply-version.js

@@ -1,4 +1,4 @@
-const log = require('proc-log')
+const { log } = require('proc-log')
 const PackageJson = require('@npmcli/package-json')
 
 const run = async ({ config: c }) => {

package/lib/check/check-apply.js

@@ -1,4 +1,4 @@
-const log = require('proc-log')
+const { log } = require('proc-log')
 const { relative, basename } = require('path')
 const { rmEach, parseEach } = require('../util/files.js')
 const { partition } = require('lodash')

package/lib/check/check-gitignore.js

@@ -1,4 +1,4 @@
-const log = require('proc-log')
+const { log } = require('proc-log')
 const { resolve, relative, basename } = require('path')
 const fs = require('fs/promises')
 const { existsSync } = require('fs')

package/lib/check/check-required.js

@@ -1,4 +1,4 @@
-const log = require('proc-log')
+const { log } = require('proc-log')
 const npa = require('npm-package-arg')
 const { partition } = require('lodash')
 const hasPackage = require('../util/has-package.js')

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

@@ -15,6 +15,7 @@ steps:
   - name: Publish
     env:
       PUBLISH_TOKEN: $\{{ secrets.PUBLISH_TOKEN }}
+      RELEASES: $\{{ inputs.releases }}
   {{else}}
   {{> stepsSetupYml }}
   - name: Check If Published
@@ -30,7 +31,7 @@ steps:
         fi
       }
 
-      for release in $(echo '$\{{ inputs.releases }}' | jq -r '.[] | @base64'); do
+      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")

package/lib/content/commitlintrc-js.hbs

@@ -3,6 +3,7 @@ module.exports = {
   rules: {
     'type-enum': [2, 'always', [{{{ join (quote (pluck changelogTypes "type")) }}}]],
     'header-max-length': [2, 'always', 80],
-    'subject-case': [0, 'always', ['lower-case', 'sentence-case', 'start-case']],
+    'subject-case': [0],
+    'body-max-line-length': [0],
   },
 }

package/lib/index.js

@@ -1,4 +1,4 @@
-const log = require('proc-log')
+const { log } = require('proc-log')
 const { resolve } = require('path')
 const getConfig = require('./config.js')
 const PackageJson = require('@npmcli/package-json')

package/lib/release/changelog.js

@@ -110,7 +110,7 @@ class ChangelogNotes {
     return authorsByCommit
   }
 
-  async #getPullRequestForCommits (commits) {
+  async #getPullRequestNumbersForCommits (commits) {
     const shas = commits
       .filter(c => !c.pullRequest?.number)
       .map(c => c.sha)
@@ -134,7 +134,7 @@ class ChangelogNotes {
     return pullRequestsByCommit
   }
 
-  #buildEntry (commit, { authors = [], pullRequest }) {
+  #buildEntry (commit) {
     const entry = []
 
     if (commit.sha) {
@@ -143,7 +143,7 @@ class ChangelogNotes {
     }
 
     // A link to the pull request if the commit has one
-    const commitPullRequest = commit.pullRequest?.number ?? pullRequest
+    const commitPullRequest = commit.pullRequestNumber
     if (commitPullRequest) {
       entry.push(link(`#${commitPullRequest}`, this.#ghUrl('pull', commitPullRequest)))
     }
@@ -154,21 +154,65 @@ class ChangelogNotes {
     entry.push([scope, subject].filter(Boolean).join(' '))
 
     // A list og the authors github handles or names
-    if (authors.length) {
-      entry.push(`(${authors.join(', ')})`)
+    if (commit.authors.length) {
+      entry.push(`(${commit.authors.join(', ')})`)
     }
 
     return entry.join(' ')
   }
 
-  async buildNotes (commits, { version, previousTag, currentTag, changelogSections }) {
+  #filterCommits (commits) {
+    const filteredCommits = []
+    const keyedDuplicates = {}
+
+    // Filter certain commits so we can make sure only the latest version of
+    // each one gets into the changelog
+    for (const commit of commits) {
+      if (commit.bareMessage.startsWith('postinstall for dependabot template-oss PR')) {
+        keyedDuplicates.templateOssPostInstall ??= []
+        keyedDuplicates.templateOssPostInstall.push(commit)
+        continue
+      }
+
+      if (commit.bareMessage.startsWith('bump @npmcli/template-oss from')) {
+        keyedDuplicates.templateOssBump ??= []
+        keyedDuplicates.templateOssBump.push(commit)
+        continue
+      }
+
+      filteredCommits.push(commit)
+    }
+
+    // Sort all our duplicates so we get the latest verion (by PR number) of each type.
+    // Then flatten so we can put them all back into the changelog
+    const sortedDupes = Object.values(keyedDuplicates)
+      .filter((items) => Boolean(items.length))
+      .map((items) => items.sort((a, b) => b.pullRequestNumber - a.pullRequestNumber))
+      .flatMap(items => items[0])
+
+    // This moves them to the bottom of their changelog section which is not
+    // strictly necessary but it's easier to do this way.
+    for (const duplicate of sortedDupes) {
+      filteredCommits.push(duplicate)
+    }
+
+    return filteredCommits
+  }
+
+  async buildNotes (rawCommits, { version, previousTag, currentTag, changelogSections }) {
     // get authors for commits for each sha
-    const authorsByCommit = await this.#getAuthorsForCommits(commits)
+    const authors = await this.#getAuthorsForCommits(rawCommits)
 
     // when rebase merging multiple commits with a single PR, only the first commit
     // will have a pr number when coming from release-please. this check will manually
     // lookup commits without a pr number and find one if it exists
-    const pullRequestByCommit = await this.#getPullRequestForCommits(commits)
+    const prNumbers = await this.#getPullRequestNumbersForCommits(rawCommits)
+
+    const fullCommits = rawCommits.map((commit) => {
+      commit.authors = authors[commit.sha] ?? []
+      commit.pullRequestNumber = Number(commit.pullRequest?.number ?? prNumbers[commit.sha])
+      return commit
+    })
 
     const changelog = new Changelog({
       version,
@@ -178,12 +222,9 @@ class ChangelogNotes {
       sections: changelogSections,
     })
 
-    for (const commit of commits) {
+    for (const commit of this.#filterCommits(fullCommits)) {
       // Collect commits by type
-      changelog.add(commit.type, this.#buildEntry(commit, {
-        authors: authorsByCommit[commit.sha],
-        pullRequest: pullRequestByCommit[commit.sha],
-      }))
+      changelog.add(commit.type, this.#buildEntry(commit))
 
       // And breaking changes to its own section
       changelog.add(Changelog.BREAKING, ...commit.notes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@npmcli/template-oss",
-  "version": "4.21.3",
+  "version": "4.21.4",
   "description": "templated files used in npm CLI team oss projects",
   "main": "lib/content/index.js",
   "bin": {
@@ -34,8 +34,8 @@
   "license": "ISC",
   "dependencies": {
     "@actions/core": "^1.9.1",
-    "@commitlint/cli": "^18.2.0",
-    "@commitlint/config-conventional": "^18.1.0",
+    "@commitlint/cli": "^19.0.3",
+    "@commitlint/config-conventional": "^19.2.2",
     "@isaacs/string-locale-compare": "^1.1.0",
     "@npmcli/arborist": "^7.2.1",
     "@npmcli/git": "^5.0.3",
@@ -55,10 +55,10 @@
     "lodash": "^4.17.21",
     "minimatch": "^9.0.2",
     "npm-package-arg": "^11.0.1",
-    "proc-log": "^3.0.0",
+    "proc-log": "^4.0.0",
     "release-please": "16.3.1",
     "semver": "^7.3.5",
-    "undici": "^5.27.2",
+    "undici": "^6.7.0",
     "yaml": "^2.1.1"
   },
   "files": [