@npmcli/template-oss 4.4.5 → 4.5.1

package/bin/release-manager.js

@@ -0,0 +1,260 @@
+#!/usr/bin/env node
+
+const { Octokit } = require('@octokit/rest')
+const semver = require('semver')
+const mapWorkspaces = require('@npmcli/map-workspaces')
+const { join } = require('path')
+
+const log = (...logs) => console.error('LOG', ...logs)
+
+const ROOT = process.cwd()
+const pkg = require(join(ROOT, 'package.json'))
+
+/* eslint-disable max-len */
+const DEFAULT_RELEASE_PROCESS = `
+1. Checkout the release branch and test
+
+    \`\`\`sh
+    gh pr checkout <PR-NUMBER> --force
+    npm i
+    npm test
+    gh pr checks --watch
+    \`\`\`
+
+1. Publish workspaces
+
+    \`\`\`sh
+    npm publish -w <WS-PKG-N>
+    \`\`\`
+
+1. Publish
+
+    \`\`\`sh
+    npm publish <PUBLISH-FLAGS>
+    \`\`\`
+
+1. Merge release PR
+
+    \`\`\`sh
+    gh pr merge --rebase
+    git checkout <BASE-BRANCH>
+    git fetch
+    git reset --hard origin/<BASE-BRANCH>
+    \`\`\`
+
+1. Check For Release Tags
+
+    Release Please will run on the just pushed release commit and create GitHub releases and tags for each package.
+
+    \`\`\`
+    gh run watch \`gh run list -w release -b <BASE-BRANCH> -L 1 --json databaseId -q ".[0].databaseId"\`
+    \`\`\`
+` /* eslint-enable max-len */
+
+const getReleaseProcess = async ({ owner, repo }) => {
+  const RELEASE_LIST_ITEM = /^\d+\.\s/gm
+
+  log(`Fetching release process from:`, owner, repo, 'wiki')
+
+  let releaseProcess = ''
+  try {
+    releaseProcess = await new Promise((resolve, reject) => {
+      require('https')
+        .get(`https://raw.githubusercontent.com/wiki/${owner}/${repo}/Release-Process.md`, resp => {
+          let d = ''
+          resp.on('data', c => (d += c))
+          resp.on('end', () => {
+            if (resp.statusCode !== 200) {
+              reject(new Error(`${resp.req.protocol + resp.req.host + resp.req.path}: ${d}`))
+            } else {
+              resolve(d)
+            }
+          })
+        })
+        .on('error', reject)
+    })
+  } catch (e) {
+    log('Release wiki not found', e.message)
+    log('Using default release process')
+    releaseProcess = DEFAULT_RELEASE_PROCESS.trim() + '\n'
+  }
+
+  // XXX: the release steps need to always be the last thing in the doc for this to work
+  const releaseLines = releaseProcess.split('\n')
+  const releaseStartLine = releaseLines.reduce((acc, line, index) =>
+    line.match(/^#+\s/) ? index : acc, 0)
+  const section = releaseLines.slice(releaseStartLine).join('\n')
+
+  return section.split({
+    [Symbol.split] (str) {
+      const [, ...matches] = str.split(RELEASE_LIST_ITEM)
+      log(`Found ${matches.length} release items`)
+      return matches.map((m) => `- [ ] <STEP_INDEX>. ${m}`.trim())
+    },
+  })
+}
+
+const getPrReleases = async (pr) => {
+  const RELEASE_SEPARATOR = /<details><summary>.*<\/summary>/g
+  const MONO_VERSIONS = /<details><summary>(?:(.*?):\s)?(.*?)<\/summary>/
+  const ROOT_VERSION = /\n##\s\[(.*?)\]/
+
+  const workspaces = [...await mapWorkspaces({ pkg: pkg, cwd: ROOT })].reduce((acc, [k]) => {
+    const wsComponentName = k.startsWith('@') ? k.split('/')[1] : k
+    acc[wsComponentName] = k
+    return acc
+  }, {})
+
+  const getReleaseInfo = ({ name, version: rawVersion }) => {
+    const version = semver.parse(rawVersion)
+    const prerelease = !!version.prerelease.length
+    const tag = `${name ? `${name}-` : ''}v${rawVersion}`
+    const workspace = workspaces[name]
+
+    return {
+      name,
+      tag,
+      prerelease,
+      version: rawVersion,
+      major: version.major,
+      url: `https://github.com/${pr.base.repo.full_name}/releases/tag/${tag}`,
+      flags: `${name ? `-w ${workspace}` : ''} ${prerelease ? `--tag prerelease` : ''}`.trim(),
+    }
+  }
+
+  const releases = pr.body.match(RELEASE_SEPARATOR)
+
+  if (!releases) {
+    log('Found no monorepo, checking for single root version')
+    const [, version] = pr.body.match(ROOT_VERSION) || []
+
+    if (!version) {
+      throw new Error('Could not find version with:', ROOT_VERSION)
+    }
+
+    log('Found version', version)
+    return [getReleaseInfo({ version })]
+  }
+
+  log(`Found ${releases.length} releases`)
+
+  return releases.reduce((acc, r) => {
+    const [, name, version] = r.match(MONO_VERSIONS)
+    const release = getReleaseInfo({ name, version })
+
+    if (!name) {
+      log('Found root', release)
+      acc[0] = release
+    } else {
+      log('Found workspace', release)
+      acc[1].push(release)
+    }
+
+    return acc
+  }, [null, []])
+}
+
+const appendToComment = async ({ github, commentId, title, body }) => {
+  if (!commentId) {
+    log(`No comment id, skipping append to comment`)
+    return
+  }
+
+  const { data: comment } = await github.rest.issues.getComment({
+    ...github.repo,
+    comment_id: commentId,
+  })
+
+  const hasAppended = comment.body.includes(title)
+
+  log('Found comment with id:', commentId)
+  log(hasAppended ? 'Comment has aready been appended, replacing' : 'Appending to comment')
+
+  const prefix = hasAppended
+    ? comment.body.split(title)[0]
+    : comment.body
+
+  return github.rest.issues.updateComment({
+    ...github.repo,
+    comment_id: commentId,
+    body: [prefix, title, body].join('\n\n'),
+  })
+}
+
+const main = async (env) => {
+  // These env vars are set by the release.yml workflow from template-oss
+  const {
+    CI,
+    GITHUB_TOKEN,
+    GITHUB_REPOSITORY,
+    RELEASE_PR_NUMBER,
+    RELEASE_COMMENT_ID, // comment is optional for testing
+  } = env
+
+  if (!CI || !GITHUB_TOKEN || !GITHUB_REPOSITORY || !RELEASE_PR_NUMBER) {
+    throw new Error('This script is designed to run in CI. If you want to test it, set the ' +
+      `following env vars: \`CI, GITHUB_TOKEN, GITHUB_REPOSITORY, RELEASE_PR_NUMBER\``)
+  }
+
+  const [owner, repo] = GITHUB_REPOSITORY.split('/')
+  const github = new Octokit({ auth: GITHUB_TOKEN })
+  github.repo = { owner, repo }
+
+  const { data: pr } = await github.rest.pulls.get({
+    ...github.repo,
+    pull_number: RELEASE_PR_NUMBER,
+  })
+
+  const [release, workspaces = []] = await getPrReleases(pr)
+
+  const RELEASE_OMIT_PRERELEASE = '> NOT FOR PRERELEASE'
+  const RELEASE_OMIT_WORKSPACES = 'Publish workspaces'
+  const releaseItems = (await getReleaseProcess({ owner, repo }))
+    .filter((item) => {
+      if (release.prerelease && item.includes(RELEASE_OMIT_PRERELEASE)) {
+        return false
+      }
+
+      if (!workspaces.length && item.includes(RELEASE_OMIT_WORKSPACES)) {
+        return false
+      }
+
+      return true
+    })
+    .map((item, index) => item.replace('<STEP_INDEX>', index + 1))
+
+  log(
+    `Filtered ${releaseItems.length} release process items:\n`,
+    releaseItems.map(r => r.split('\n')[0].replace('- [ ] ', '')).join(', ')
+  )
+
+  const releaseTitle = `### Release Checklist for ${release.tag}`
+  const releaseChecklist = releaseItems
+    .join('\n\n')
+    .replace(/<PR-NUMBER>/g, RELEASE_PR_NUMBER)
+    .replace(/<RELEASE-BRANCH>/g, pr.head.ref)
+    .replace(/<BASE-BRANCH>/g, pr.base.ref)
+    .replace(/<MAJOR>/g, release.major)
+    .replace(/<X\.Y\.Z>/g, release.version)
+    .replace(/<GITHUB-RELEASE-LINK>/g, release.url)
+    .replace(/<PUBLISH-FLAGS>/g, release.flags)
+    .replace(/^(\s*\S.*)(-w <WS-PKG-N>)$/gm, workspaces.map(w => `$1${w.flags}`).join('\n'))
+    .trim()
+
+  await appendToComment({
+    github,
+    commentId: RELEASE_COMMENT_ID,
+    title: releaseTitle,
+    body: releaseChecklist,
+  })
+
+  if (!RELEASE_COMMENT_ID) {
+    console.log(releaseChecklist)
+  }
+}
+
+main(process.env)
+  // This is part of the release CI and is for posting a release manager
+  // comment to the issue but we dont want it to ever fail the workflow so
+  // just log but dont set the error code
+  .catch(err => console.error(err))

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: '-ws -iwr --if-present',
+    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-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/post-dependabot.yml

@@ -11,7 +11,7 @@ jobs:
     {{> job
       jobName="template-oss"
       jobIf="github.actor == 'dependabot[bot]'"
-      jobCheckout=(obj ref="${{ github.ref_name }}")
+      jobCheckout=(obj ref="${{ github.event.pull_request.head.ref }}")
     }}
       - name: Fetch Dependabot Metadata
         id: metadata

package/lib/content/release.yml

@@ -77,7 +77,8 @@ jobs:
           RELEASE_COMMENT_ID: $\{{ needs.release.outputs.comment-id }}
           GITHUB_TOKEN: $\{{ secrets.GITHUB_TOKEN }}
         run: |
-          {{ rootNpmPath }} run rp-pull-request --ignore-scripts {{ allFlags }}
+          {{ rootNpmPath }} exec --offline -- template-oss-release-manager
+          {{ rootNpmPath }} run rp-pull-request --ignore-scripts {{~#if allFlags}} {{ allFlags }}{{else}} --if-present{{/if}}
       - name: Commit
         id: commit
         env:

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

@@ -81,9 +81,13 @@ module.exports = class extends NodeWorkspace {
       for (const [depName, resolved] of graphPackage.localDependencies) {
         const depVersion = updatedVersions.get(depName)
         const isNotDir = resolved.type !== 'directory'
-        // Changelog entries are only added for dependencies and not any other type
-        const isDep = Object.prototype.hasOwnProperty.call(pkg.dependencies, depName)
-        if (depVersion && isNotDir && isDep) {
+
+        // Due to some bugs in release-please we need to create `deps:` commits
+        // for all dev and prod dependencies even though we normally would only
+        // do a `chore:` commit to bump a dev dep. The tradeoff is an extra
+        // patch release to workspaces that depend on other workspaces as dev
+        // dependencies.
+        if (depVersion && isNotDir) {
           commitsByPath[path].push({
             message: `deps(${SCOPE}): ${depName} ${depVersion.toString()}`,
           })

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@npmcli/template-oss",
-  "version": "4.4.5",
+  "version": "4.5.1",
   "description": "templated files used in npm CLI team oss projects",
   "main": "lib/content/index.js",
   "bin": {
     "template-oss-apply": "bin/apply.js",
     "template-oss-check": "bin/check.js",
-    "template-oss-release-please": "bin/release-please.js"
+    "template-oss-release-please": "bin/release-please.js",
+    "template-oss-release-manager": "bin/release-manager.js"
   },
   "scripts": {
     "lint": "eslint \"**/*.js\"",
@@ -37,6 +38,7 @@
     "@npmcli/git": "^3.0.0",
     "@npmcli/map-workspaces": "^2.0.2",
     "@npmcli/package-json": "^2.0.0",
+    "@octokit/rest": "^19.0.4",
     "diff": "^5.0.0",
     "glob": "^8.0.1",
     "handlebars": "^4.7.7",
@@ -47,7 +49,7 @@
     "lodash": "^4.17.21",
     "npm-package-arg": "^9.0.1",
     "proc-log": "^2.0.0",
-    "release-please": "npm:@npmcli/release-please@^14.2.5",
+    "release-please": "npm:@npmcli/release-please@^14.2.6",
     "semver": "^7.3.5",
     "yaml": "^2.1.1"
   },