@npmcli/template-oss 4.20.0 → 4.21.1

package/lib/release/release-please.js

@@ -0,0 +1,180 @@
+const RP = require('release-please')
+const {
+  DefaultVersioningStrategy,
+} = require('release-please/build/src/versioning-strategies/default.js')
+const {
+  PrereleaseVersioningStrategy,
+} = require('release-please/build/src/versioning-strategies/prerelease.js')
+const { ROOT_PROJECT_PATH } = require('release-please/build/src/manifest.js')
+const { CheckpointLogger, logger } = require('release-please/build/src/util/logger.js')
+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')
+
+class ReleasePlease {
+  #token
+  #owner
+  #repo
+  #branch
+  #backport
+  #defaultTag
+  #overrides
+  #silent
+  #trace
+  #info
+
+  #github
+  #octokit
+  #manifest
+
+  constructor ({
+    token,
+    repo,
+    branch,
+    backport,
+    defaultTag,
+    overrides,
+    silent,
+    trace,
+  }) {
+    assert(token, 'token is required')
+    assert(repo, 'repo is required')
+    assert(branch, 'branch is required')
+    assert(defaultTag, 'defaultTag is required')
+
+    this.#token = token
+    this.#owner = repo.split('/')[0]
+    this.#repo = repo.split('/')[1]
+    this.#branch = branch
+    this.#backport = backport
+    this.#defaultTag = defaultTag
+    this.#overrides = overrides
+    this.#silent = silent
+    this.#trace = trace
+  }
+
+  static async run (options) {
+    const releasePlease = new ReleasePlease(options)
+    await releasePlease.init()
+    return releasePlease.run()
+  }
+
+  async init () {
+    RP.registerChangelogNotes('default', ({ github, ...o }) =>
+      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))
+
+    if (this.#silent) {
+      this.#info = noop
+      RP.setLogger(Object.entries(logger).reduce((acc, [k, v]) => {
+        if (typeof v === 'function') {
+          acc[k] = noop
+        }
+        return acc
+      }, {}))
+    } else {
+      this.#info = core.info
+      RP.setLogger(new CheckpointLogger(true, !!this.#trace))
+    }
+
+    this.#github = await RP.GitHub.create({
+      owner: this.#owner,
+      repo: this.#repo,
+      token: this.#token,
+    })
+    this.#octokit = this.#github.octokit
+    this.#manifest = await RP.Manifest.fromManifest(
+      this.#github,
+      this.#branch,
+      undefined,
+      undefined,
+      this.#overrides
+    )
+  }
+
+  async run () {
+    const rootPr = await this.#getRootPullRequest()
+    const releases = await this.#getReleases()
+
+    if (rootPr) {
+      this.#info(`root pr: ${JSON.stringify(omit(rootPr, 'body'))}`)
+
+      // release please does not guarantee that the release PR will have the latest sha,
+      // but we always need it so we can attach the relevant checks to the sha.
+      rootPr.sha = await this.#octokit.paginate(this.#octokit.rest.pulls.listCommits, {
+        owner: this.#owner,
+        repo: this.#repo,
+        pull_number: rootPr.number,
+      }).then(r => r[r.length - 1].sha)
+    }
+
+    if (releases) {
+      this.#info(`found releases: ${releases.length}`)
+
+      for (const release of releases) {
+        this.#info(`release: ${JSON.stringify(omit(release, 'notes'))}`)
+
+        release.publishTag = getPublishTag(release.version, {
+          backport: this.#backport,
+          defaultTag: this.#defaultTag,
+        })
+
+        release.prNumber = await this.#octokit.rest.repos.listPullRequestsAssociatedWithCommit({
+          owner: this.#owner,
+          repo: this.#repo,
+          commit_sha: release.sha,
+          per_page: 1,
+        }).then(r => r.data[0]?.number)
+
+        release.pkgName = await this.#octokit.rest.repos.getContent({
+          owner: this.#owner,
+          repo: this.#repo,
+          ref: this.#branch,
+          path: `${release.path === '.' ? '' : release.path}/package.json`,
+        }).then(r => JSON.parse(Buffer.from(r.data.content, r.data.encoding)).name)
+      }
+    }
+
+    return {
+      pr: rootPr,
+      releases: releases,
+    }
+  }
+
+  async #getRootPullRequest () {
+    // We only ever get a single pull request with our current release-please settings
+    // Update this if we start creating individual PRs per workspace release
+    const pullRequests = await this.#manifest.createPullRequests()
+    return pullRequests.filter(Boolean)[0] ?? null
+  }
+
+  async #getReleases () {
+    // if we have a root release, always put it as the first item in the array
+    const rawReleases = await this.#manifest.createReleases().then(r => r.filter(Boolean))
+    let rootRelease = null
+    const workspaceReleases = []
+
+    for (const release of rawReleases) {
+      if (release.path === ROOT_PROJECT_PATH) {
+        assert(!rootRelease, 'Multiple root releases detected. This should never happen.')
+        rootRelease = release
+      } else {
+        workspaceReleases.push(release)
+      }
+    }
+
+    const releases = [rootRelease, ...workspaceReleases].filter(Boolean)
+    return releases.length ? releases : null
+  }
+}
+
+module.exports = ReleasePlease

package/lib/release/util.js

@@ -0,0 +1,42 @@
+const semver = require('semver')
+
+const SPEC = new RegExp(`([^\\s]+@${semver.src[semver.tokens.FULLPLAIN]})`, 'g')
+const code = (c) => `\`${c}\``
+const wrapSpecs = (str) => str.replace(SPEC, code('$1'))
+const block = (lang) => `\`\`\`${lang ? `${lang}` : ''}`
+const link = (text, url) => `[${text}](${url})`
+const list = (text) => `* ${text}`
+const formatDate = (date = new Date()) => {
+  const year = date.getFullYear()
+  const month = (date.getMonth() + 1).toString().padStart(2, '0')
+  const day = date.getDate().toString().padStart(2, '0')
+  return [year, month, day].join('-')
+}
+
+const getPublishTag = (v, { backport, defaultTag }) => {
+  const version = semver.parse(v)
+  return version.prerelease.length
+    ? `prerelease-${version.major}`
+    : backport ? `latest-${backport}`
+    : defaultTag.replace(/{{\s*major\s*}}/, version.major)
+}
+
+const makeGitHubUrl = (owner, repo) =>
+  (...p) => `https://github.com/${owner}/${repo}/${p.join('/')}`
+
+const noop = () => {}
+
+module.exports = {
+  // we use this string a lot, its duplicated in the changelog sections but its hard
+  // to access from within release please so we keep it here also.
+  DEPS: 'deps',
+  wrapSpecs,
+  code,
+  block,
+  link,
+  list,
+  formatDate,
+  getPublishTag,
+  makeGitHubUrl,
+  noop,
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@npmcli/template-oss",
-  "version": "4.20.0",
+  "version": "4.21.1",
   "description": "templated files used in npm CLI team oss projects",
   "main": "lib/content/index.js",
   "bin": {
@@ -19,7 +19,8 @@
     "postlint": "template-oss-check",
     "postinstall": "template-oss-apply",
     "test-all": "npm run test -ws -iwr --if-present",
-    "lint-all": "npm run lint -ws -iwr --if-present"
+    "lint-all": "npm run lint -ws -iwr --if-present",
+    "test:record": "TAP_SNAPSHOT=1 NOCK_RECORD=1 tap"
   },
   "repository": {
     "type": "git",
@@ -41,6 +42,7 @@
     "@npmcli/map-workspaces": "^3.0.0",
     "@npmcli/package-json": "^5.0.0",
     "@octokit/rest": "^19.0.4",
+    "dedent": "^1.5.1",
     "diff": "^5.0.0",
     "glob": "^10.1.0",
     "handlebars": "^4.7.7",
@@ -49,12 +51,14 @@
     "json-parse-even-better-errors": "^3.0.0",
     "just-deep-map-values": "^1.1.1",
     "just-diff": "^6.0.0",
+    "just-omit": "^2.2.0",
     "lodash": "^4.17.21",
     "minimatch": "^9.0.2",
     "npm-package-arg": "^11.0.1",
     "proc-log": "^3.0.0",
-    "release-please": "npm:@npmcli/release-please@^14.2.6",
+    "release-please": "16.3.1",
     "semver": "^7.3.5",
+    "undici": "^5.27.2",
     "yaml": "^2.1.1"
   },
   "files": [
@@ -64,6 +68,7 @@
   "devDependencies": {
     "@npmcli/eslint-config": "^4.0.0",
     "@npmcli/template-oss": "file:./",
+    "nock": "^13.3.8",
     "tap": "^16.0.0"
   },
   "tap": {
@@ -74,7 +79,10 @@
       "--exclude",
       "tap-snapshots/**"
     ],
-    "test-ignore": "^(workspace/test-workspace)/"
+    "test-ignore": "^(workspace/test-workspace)/",
+    "node-arg": [
+      "--no-experimental-fetch"
+    ]
   },
   "templateOSS": {
     "//@npmcli/template-oss": "This file is partially managed by @npmcli/template-oss. Edits may be overwritten.",

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

@@ -1,54 +0,0 @@
-{{#if jobCheck.sha}}
-- name: Get Workflow Job
-  uses: actions/github-script@v6
-  if: {{ jobCheck.sha }}
-  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.6.0
-  {{#if jobCheck.sha}}
-  id: check
-  if: {{ jobCheck.sha }}
-  {{else}}
-  if: {{#if jobCheck.id}}{{ jobCheck.id }}{{else}}steps.check.outputs.check_id{{/if}} && always()
-  {{/if}}
-  with:
-    token: $\{{ secrets.GITHUB_TOKEN }}
-    {{#if jobCheck.sha}}
-    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 }} }}
-    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}} }}
-    {{/if}}

package/lib/release-please/changelog.js

@@ -1,92 +0,0 @@
-const makeGh = require('./github.js')
-const { link, code, specRe, list, dateFmt } = require('./util')
-
-module.exports = class ChangelogNotes {
-  constructor (options) {
-    this.gh = makeGh(options.github)
-  }
-
-  buildEntry (commit, authors = []) {
-    const breaking = commit.notes
-      .filter(n => n.title === 'BREAKING CHANGE')
-      .map(n => n.text)
-
-    const entry = []
-
-    if (commit.sha) {
-      // A link to the commit
-      entry.push(link(code(commit.sha.slice(0, 7)), this.gh.commit(commit.sha)))
-    }
-
-    // A link to the pull request if the commit has one
-    const prNumber = commit.pullRequest?.number
-    if (prNumber) {
-      entry.push(link(`#${prNumber}`, this.gh.pull(prNumber)))
-    }
-
-    // The title of the commit, with the optional scope as a prefix
-    const scope = commit.scope && `${commit.scope}:`
-    const subject = commit.bareMessage.replace(specRe, code('$1'))
-    entry.push([scope, subject].filter(Boolean).join(' '))
-
-    // A list og the authors github handles or names
-    if (authors.length && commit.type !== 'deps') {
-      entry.push(`(${authors.join(', ')})`)
-    }
-
-    return {
-      entry: entry.join(' '),
-      breaking,
-    }
-  }
-
-  async buildNotes (rawCommits, { version, previousTag, currentTag, changelogSections }) {
-    const changelog = changelogSections.reduce((acc, c) => {
-      if (!c.hidden) {
-        acc[c.type] = {
-          title: c.section,
-          entries: [],
-        }
-      }
-      return acc
-    }, {
-      breaking: {
-        title: '⚠️ BREAKING CHANGES',
-        entries: [],
-      },
-    })
-
-    // Only continue with commits that will make it to our changelog
-    const commits = rawCommits.filter(c => changelog[c.type])
-
-    const authorsByCommit = await this.gh.authors(commits)
-
-    // Group commits by type
-    for (const commit of commits) {
-      // 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
-      if (!commit.pullRequest?.number) {
-        commit.pullRequest = { number: await this.gh.commitPrNumber(commit) }
-      }
-      const { entry, breaking } = this.buildEntry(
-        commit,
-        authorsByCommit[commit.sha]
-      )
-
-      // Collect commits by type
-      changelog[commit.type].entries.push(entry)
-
-      // And push breaking changes to its own section
-      changelog.breaking.entries.push(...breaking)
-    }
-
-    const sections = Object.values(changelog)
-      .filter((s) => s.entries.length)
-      .map(({ title, entries }) => [`### ${title}`, entries.map(list).join('\n')].join('\n\n'))
-
-    const title = `## ${link(version, this.gh.compare(previousTag, currentTag))} (${dateFmt()})`
-
-    return [title, ...sections].join('\n\n').trim()
-  }
-}

package/lib/release-please/github.js

@@ -1,72 +0,0 @@
-module.exports = (gh) => {
-  const { owner, repo } = gh.repository
-
-  const authors = async (commits) => {
-    const response = {}
-
-    const shas = commits.map(c => c.sha).filter(Boolean)
-
-    if (!shas.length) {
-      return response
-    }
-
-    try {
-      const { repository } = await gh.graphql(
-        `fragment CommitAuthors on GitObject {
-          ... on Commit {
-            authors (first:10) {
-              nodes {
-                user { login }
-                name
-              }
-            }
-          }
-        }
-        query {
-          repository (owner:"${owner}", name:"${repo}") {
-            ${shas.map((s) => {
-              return `_${s}: object (expression: "${s}") { ...CommitAuthors }`
-            })}
-          }
-        }`
-      )
-
-      for (const [key, commit] of Object.entries(repository)) {
-        if (commit) {
-          response[key.slice(1)] = commit.authors.nodes
-            .map((a) => a.user && a.user.login ? `@${a.user.login}` : a.name)
-            .filter(Boolean)
-        }
-      }
-
-      return response
-    } catch {
-      return response
-    }
-  }
-
-  const commitPrNumber = async (commit) => {
-    try {
-      const res = await gh.octokit.rest.repos.listPullRequestsAssociatedWithCommit({
-        owner,
-        repo,
-        commit_sha: commit.sha,
-        per_page: 1,
-      })
-      return res.data[0].number
-    } catch {
-      return null
-    }
-  }
-
-  const url = (...p) => `https://github.com/${owner}/${repo}/${p.join('/')}`
-
-  return {
-    authors,
-    commitPrNumber,
-    pull: (number) => url('pull', number),
-    commit: (sha) => url('commit', sha),
-    compare: (a, b) => a ? url('compare', `${a.toString()}...${b.toString()}`) : null,
-    release: (tag) => url('releases', 'tag', tag.toString()),
-  }
-}