@npmcli/template-oss 4.2.0 → 4.3.0

package/lib/content/index.js

@@ -1,33 +1,49 @@
 const { name: NAME, version: LATEST_VERSION } = require('../../package.json')
 
-const releasePlease = () => ({
-  '.github/workflows/release-please.yml': {
-    file: 'release-please.yml',
-    filter: (o) => !o.pkg.private,
-  },
+const isPublic = (p) => !p.pkg.private
+
+const sharedRoot = (name) => ({
+  // release
   '.github/workflows/release.yml': {
     file: 'release.yml',
-    filter: (o) => !o.pkg.private,
+    filter: isPublic,
+  },
+  '.github/workflows/ci-release.yml': {
+    file: 'ci-release.yml',
+    filter: isPublic,
   },
   '.release-please-manifest.json': {
     file: 'release-please-manifest.json',
-    filter: (o) => !o.pkg.private,
-    parser: (p) => class NoCommentJson extends p.JsonMerge {
+    filter: isPublic,
+    parser: (p) => class extends p.JsonMerge {
       comment = null
     },
   },
   'release-please-config.json': {
     file: 'release-please-config.json',
-    filter: (o) => !o.pkg.private,
-    parser: (p) => class NoCommentJson extends p.JsonMerge {
+    filter: isPublic,
+    parser: (p) => class extends p.JsonMerge {
       comment = null
     },
   },
-})
-
-const tap = (name) => ({
+  // ci
   '.github/matchers/tap.json': 'tap.json',
   [`.github/workflows/ci${name ? `-${name}` : ''}.yml`]: 'ci.yml',
+  // dependabot
+  '.github/dependabot.yml': {
+    file: 'dependabot.yml',
+    clean: (p) => p.config.isRoot,
+    // dependabot takes a single top level config file. this parser
+    // will run for all configured packages and each one will have
+    // its item replaced in the updates array based on the directory
+    parser: (p) => class extends p.YmlMerge {
+      key = 'updates'
+      id = 'directory'
+    },
+  },
+  '.github/workflows/post-dependabot.yml': {
+    file: 'post-dependabot.yml',
+  },
 })
 
 // Changes applied to the root of the repo
@@ -37,16 +53,14 @@ const rootRepo = {
     '.github/ISSUE_TEMPLATE/bug.yml': 'bug.yml',
     '.github/ISSUE_TEMPLATE/config.yml': 'config.yml',
     '.github/CODEOWNERS': 'CODEOWNERS',
-    '.github/dependabot.yml': 'dependabot.yml',
     '.github/workflows/audit.yml': 'audit.yml',
     '.github/workflows/codeql-analysis.yml': 'codeql-analysis.yml',
-    '.github/workflows/post-dependabot.yml': 'post-dependabot.yml',
     '.github/workflows/pull-request.yml': 'pull-request.yml',
-    ...releasePlease(),
-    ...tap(),
+    ...sharedRoot(),
   },
   rm: [
     '.github/workflows/release-test.yml',
+    '.github/workflows/release-please.yml',
   ],
 }
 
@@ -72,12 +86,11 @@ const rootModule = {
 // Changes for each workspace but applied to the root of the repo
 const workspaceRepo = {
   add: {
-    ...releasePlease(),
-    ...tap('{{pkgNameFs}}'),
+    ...sharedRoot('{{ pkgNameFs }}'),
   },
   rm: [
     // These are the old release please files that should be removed now
-    '.github/workflows/release-please-{{pkgNameFs}}.yml',
+    '.github/workflows/release-please-{{ pkgNameFs }}.yml',
   ],
 }
 
@@ -104,7 +117,6 @@ module.exports = {
   macCI: true,
   branches: ['main', 'latest'],
   releaseBranches: [],
-  defaultBranch: 'main',
   distPaths: [
     'bin/',
     'lib/',
@@ -128,6 +140,7 @@ module.exports = {
   lockfile: false,
   npm: 'npm',
   npx: 'npx',
+  dependabot: 'increase-if-necessary',
   unwantedPackages: [
     'eslint',
     'eslint-plugin-node',

package/lib/content/npmrc

@@ -1 +1 @@
-package-lock={{lockfile}}
+package-lock={{ lockfile }}

package/lib/content/pkg.json

@@ -1,45 +1,47 @@
 {
   "author": "GitHub Inc.",
-  "files": {{{json distPaths}}},
+  "files": {{{ json distPaths }}},
   "scripts": {
     "lint": "eslint \"**/*.js\"",
     "postlint": "template-oss-check",
     "template-oss-apply": "template-oss-apply --force",
-    "lintfix": "{{localNpmPath}} run lint -- --fix",
-    "preversion": {{{del}}},
-    "postversion": {{{del}}},
-    "prepublishOnly": {{{del}}},
-    "postpublish": {{{del}}},
+    "lintfix": "{{ localNpmPath }} run lint -- --fix",
     "snap": "tap",
     "test": "tap",
-    "posttest": "{{localNpmPath}} run lint",
+    "posttest": "{{ localNpmPath }} run lint",
     {{#if isRootMono}}
-    "test-all": "{{localNpmPath}} run test -ws -iwr --if-present",
-    "lint-all": "{{localNpmPath}} run lint -ws -iwr --if-present",
+    "test-all": "{{ localNpmPath }} run test {{ allFlags }}",
+    "lint-all": "{{ localNpmPath }} run lint {{ allFlags }}",
     {{/if}}
-    "template-copy": {{{del}}},
-    "lint:fix": {{{del}}}
+    "template-copy": {{{ del }}},
+    "lint:fix": {{{ del }}},
+    "preversion": {{{ del }}},
+    "postversion": {{{ del }}},
+    "prepublishOnly": {{{ del }}},
+    "postpublish": {{{ del }}}
   },
-  "repository": {{#if repository}}{{{json repository}}}{{else}}{{{del}}}{{/if}},
+  "repository": {{#if repository}}{{{ json repository }}}{{else}}{{{ del }}}{{/if}},
   "engines": {
     {{#if engines}}
-    "node": {{{json engines}}}
+    "node": {{{ json engines }}}
     {{/if}}
   },
-  {{{json __CONFIG_KEY__}}}: {
-    "version": {{#if isDogFood}}{{{del}}}{{else}}{{{json __VERSION__}}}{{/if}}
+  {{{ json __CONFIG_KEY__ }}}: {
+    "version": {{#if isDogFood}}{{{ del }}}{{else}}{{{ json __VERSION__ }}}{{/if}}
   },
-  "templateVersion": {{{del}}},
-  "standard": {{{del}}},
+  "templateVersion": {{{ del }}},
+  "standard": {{{ del }}},
   "tap": {
-    {{#if isRootMono}}
-    "test-ignore": "^({{#each workspaceGlobs}}{{this}}{{#unless @last}}|{{/unless}}{{/each}})/",
+    {{#if workspacePaths}}
+    "test-ignore": "^({{ join workspacePaths "|" }})/**",
     {{/if}}
     "nyc-arg": [
-      {{#if isRootMono}}
-      {{#each workspaceGlobs}}"--exclude", "{{this}}/**",{{/each}}
-      {{/if}}
-      "--exclude", "tap-snapshots/**"
+      {{#each workspaceGlobs}}
+      "--exclude",
+      "{{ . }}",
+      {{/each}}
+      "--exclude",
+      "tap-snapshots/**"
     ]
   }
 }

package/lib/content/post-dependabot.yml

@@ -1,26 +1,70 @@
-name: Post Dependabot Actions
+name: Post Dependabot
 
 on:
   pull_request
 
-# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#permissions
 permissions:
   contents: write
 
 jobs:
-  template-oss-apply:
-    {{> setupJob jobIf="github.actor == 'dependabot[bot]'" checkout=(obj ref="${{ github.event.pull_request.head_ref }}")}}
-      - name: Dependabot metadata
+  template-oss:
+    {{> job
+      jobName="template-oss"
+      jobIf="github.actor == 'dependabot[bot]'"
+      jobCheckout=(obj ref="${{ github.event.pull_request.head_ref }}")
+    }}
+      - name: Fetch Dependabot Metadata
         id: metadata
-        uses: dependabot/fetch-metadata@v1.1.1
+        uses: dependabot/fetch-metadata@v1
         with:
-          github-token: "$\{{ secrets.GITHUB_TOKEN }}"
-      - name: Apply {{__NAME__}} changes and lint
-        if: contains(steps.metadata.outputs.dependency-names, '{{__NAME__}}')
+          github-token: $\{{ secrets.GITHUB_TOKEN }}
+
+      # Dependabot can update multiple directories so we output which directory
+      # it is acting on so we can run the command for the correct root or workspace
+      - name: Get Dependabot Directory
+        if: contains(steps.metadata.outputs.dependency-names, '{{ __NAME__ }}')
+        id: flags
+        run: |
+          if [[ "$\{{ steps.metadata.outputs.directory }}" == "/" ]]; then
+            echo "::set-output name=workspace::-iwr"
+          else
+            echo "::set-output name=workspace::-w $\{{ steps.metadata.outputs.directory }}"
+          fi
+
+      - name: Apply Changes
+        if: steps.flags.outputs.workspace
+        id: apply
+        run: |
+          {{ rootNpmPath }} run template-oss-apply $\{{ steps.flags.outputs.workspace }}
+          if [[ `git status --porcelain` ]]; then
+            echo "::set-output name=changes::true"
+          fi
+
+      # This step will fail if template-oss has made any workflow updates. It is impossible
+      # for a workflow to update other workflows. In the case it does fail, we continue
+      # and then try to apply only a portion of the changes in the next step
+      - name: Push All Changes
+        if: steps.apply.outputs.changes
+        id: push
+        continue-on-error: true
         env:
           GITHUB_TOKEN: $\{{ secrets.GITHUB_TOKEN }}
         run: |
-          {{rootNpmPath}} run template-oss-apply
           git commit -am "chore: postinstall for dependabot template-oss PR"
           git push
-          {{rootNpmPath}} run lint
+
+      - name: Push All Changes Except Workflows
+        if: steps.push.outcome == 'failure'
+        env:
+          GITHUB_TOKEN: $\{{ secrets.GITHUB_TOKEN }}
+        run: |
+          git reset HEAD~
+          git checkout HEAD -- .github/workflows/
+          git clean -fd .github/workflows/
+          git commit -am "chore: postinstall for dependabot template-oss PR"
+          git push
+
+      - name: Check Changes
+        if: steps.apply.outputs.changes
+        run: |
+          {{ rootNpmPath }} exec --offline $\{{ steps.flags.outputs.workspace }} -- template-oss-check

package/lib/content/pull-request.yml

@@ -1,4 +1,4 @@
-name: Pull Request Linting
+name: Pull Request
 
 on:
   pull_request:
@@ -9,12 +9,14 @@ on:
       - synchronize
 
 jobs:
-  check:
-    name: Check PR Title or Commits
-    {{> setupJob checkout=(obj fetch-depth=0)}}
-      - name: Check commits or PR title
-        env:
-          PR_TITLE: $\{{ github.event.pull_request.title }}
+  commitlint:
+    {{> job jobName="Lint Commits" jobCheckout=(obj fetch-depth=0) }}
+      - name: Run Commitlint on Commits
+        id: commit
+        continue-on-error: true
         run: |
-          {{rootNpxPath}} --offline commitlint -V --from origin/{{defaultBranch}} --to $\{{ github.event.pull_request.head.sha }} \
-            || echo $PR_TITLE | npx --offline commitlint -V
+          {{ rootNpxPath }} --offline commitlint -V --from origin/$\{{ github.base_ref }} --to $\{{ github.event.pull_request.head.sha }}
+      - name: Run Commitlint on PR Title
+        if: steps.commit.outcome == 'failure'
+        run: |
+          echo $\{{ github.event.pull_request.title }} | {{ rootNpxPath }} --offline commitlint -V

package/lib/content/release-please-config.json

@@ -1,13 +1,13 @@
 {
-  "separate-pull-requests": {{{del}}},
-  "plugins": {{#if isMono}}["node-workspace"]{{else}}{{{del}}}{{/if}},
+  "separate-pull-requests": {{{ del }}},
+  "plugins": {{#if isMono }}["node-workspace"]{{ else }}{{{ del }}}{{/if}},
   "exclude-packages-from-root": true,
   "group-pull-request-title-pattern": "chore: release ${version}",
   "pull-request-title-pattern": "chore: release${component} ${version}",
-  "changelog-sections": {{{json changelogTypes}}},
+  "changelog-sections": {{{ json changelogTypes }}},
   "packages": {
-    "{{#unless pkgRelPath}}.{{/unless}}{{pkgRelPath}}": {
-      {{#unless pkgRelPath}}"package-name": ""{{/unless}}
+    "{{ pkgPath }}": {
+      {{#if isRoot}}"package-name": ""{{/if}}
     }
   }
 }

package/lib/content/release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  "{{#unless pkgRelPath}}.{{/unless}}{{pkgRelPath}}": "{{pkg.version}}"
+  "{{ pkgPath }}": "{{ pkg.version }}"
 }

package/lib/content/release.yml

@@ -1,20 +1,125 @@
-
 name: Release
 
 on:
-  workflow_call:
-    inputs:
-      ref:
-        required: true
-        type: string
+  push:
+    branches:
+      {{#each branches}}
+      - {{ . }}
+      {{/each}}
+      {{#each releaseBranches }}
+      - {{ . }}
+      {{/each}}
+
+permissions:
+  contents: write
+  pull-requests: write
+  checks: write
 
 jobs:
-  lint-all:
-    {{> setupJob checkout=(obj ref="${{ inputs.ref }}")}}
-      - run: {{rootNpmPath}} run lint -ws -iwr --if-present
-
-  test-all:
-    {{> setupJobMatrix checkout=(obj ref="${{ inputs.ref }}")}}
-      - name: add tap problem matcher
-        run: echo "::add-matcher::.github/matchers/tap.json"
-      - run: {{rootNpmPath}} run test -ws -iwr --if-present
+  release:
+    outputs:
+      pr: $\{{ steps.release.outputs.pr }}
+      releases: $\{{ steps.release.outputs.releases }}
+      release-flags: $\{{ steps.release.outputs.release-flags }}
+      branch: $\{{ steps.release.outputs.pr-branch }}
+      pr-number: $\{{ steps.release.outputs.pr-number }}
+      comment-id: $\{{ steps.pr-comment.outputs.result }}
+      check-id: $\{{ steps.check.outputs.check_id }}
+    {{> job jobName="Release" }}
+      - name: Release Please
+        id: release
+        env:
+          GITHUB_TOKEN: $\{{ secrets.GITHUB_TOKEN }}
+        run: |
+          {{ rootNpxPath }} --offline template-oss-release-please $\{{ github.ref_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 }}
+        with:
+          script: |
+            const repo = { owner: context.repo.owner, repo: context.repo.repo }
+            const issue = { ...repo, issue_number: process.env.PR_NUMBER }
+
+            const { data: workflow } = await github.rest.actions.getWorkflowRun({ ...repo, run_id: context.runId })
+
+            let body = '## Release Manager\n\n'
+
+            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}`
+            if (commentId) {
+              await github.rest.issues.updateComment({ ...repo, comment_id: commentId, body })
+            } else {
+              const { data: comment } = await github.rest.issues.createComment({ ...issue, body })
+              commentId = comment?.id
+            }
+
+            return commentId
+      {{> stepChecks jobCheck=(obj name="Release" sha="${{ steps.release.outputs.pr-sha }}" if="steps.release.outputs.pr-number") }}
+
+  update:
+    needs: release
+    outputs:
+      sha: $\{{ steps.commit.outputs.sha }}
+      check-id: $\{{ steps.check.outputs.check_id }}
+    {{> job
+      jobName="Update - Release"
+      jobIf="needs.release.outputs.pr"
+      jobCheckout=(obj ref="${{ needs.release.outputs.branch }}" fetch-depth=0)
+    }}
+      - name: Run Post Pull Request Actions
+        env:
+          RELEASE_PR_NUMBER: $\{{ needs.release.outputs.pr-number }}
+          RELEASE_COMMENT_ID: $\{{ needs.release.outputs.comment-id }}
+          GITHUB_TOKEN: $\{{ secrets.GITHUB_TOKEN }}
+        run: |
+          {{ rootNpmPath }} run rp-pull-request --ignore-scripts {{ allFlags }}
+      - name: Commit
+        id: commit
+        env:
+          GITHUB_TOKEN: $\{{ secrets.GITHUB_TOKEN }}
+        run: |
+          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 jobCheck=(obj id="${{ needs.release.outputs.check-id }}" )}}
+
+  ci:
+    name: CI - Release
+    needs: [release, update]
+    if: needs.release.outputs.pr
+    uses: ./.github/workflows/ci-release.yml
+    with:
+      ref: $\{{ needs.release.outputs.branch }}
+      check-sha: $\{{ needs.update.outputs.sha }}
+
+  post-ci:
+    needs: [release, update, ci]
+    {{> job jobName="Post CI - Release" jobIf="needs.release.outputs.pr && always()" jobSkipSetup=true }}
+      - name: Get Needs Result
+        id: needs-result
+        run: |
+          result=""
+          if [[ "$\{{ contains(needs.*.result, 'failure') }}" == "true" ]]; then
+            result="failure"
+          elif [[ "$\{{ contains(needs.*.result, 'cancelled') }}" == "true" ]]; then
+            result="cancelled"
+          else
+            result="success"
+          fi
+          echo "::set-output name=result::$result"
+      {{> stepChecks jobCheck=(obj id="${{ needs.update.outputs.check-id }}" status="${{ steps.needs-result.outputs.result }}") }}
+
+  post-release:
+    needs: release
+    {{> job jobName="Post Release - Release" jobIf="needs.release.outputs.releases" }}
+      - name: Run Post Release Actions
+        env:
+          RELEASES: $\{{ needs.release.outputs.releases }}
+        run: |
+          {{ rootNpmPath }} run rp-release --ignore-scripts --if-present $\{{ join(fromJSON(needs.release.outputs.release-flags), ' ') }}

package/lib/index.js

@@ -7,8 +7,8 @@ const mapWorkspaces = require('@npmcli/map-workspaces')
 const getPkg = async (path) => {
   log.verbose('get-pkg', path)
 
-  const pkg = (await PackageJson.load(path)).content
-  const pkgConfig = getConfig.getPkgConfig(pkg)
+  const pkgJson = (await PackageJson.load(path)).content
+  const pkgConfig = getConfig.getPkgConfig(pkgJson)
   log.verbose('get-pkg', pkgConfig)
 
   if (pkgConfig.content) {
@@ -16,7 +16,7 @@ const getPkg = async (path) => {
   }
 
   return {
-    pkg,
+    pkgJson,
     path,
     config: pkgConfig,
   }
@@ -25,21 +25,18 @@ const getPkg = async (path) => {
 const getWsPkgs = async (root, rootPkg) => {
   const wsPkgs = []
 
-  // workspaces are only used to filter paths and control changes to workspaces
-  // so dont pass it along with the rest of the config
-  const { workspaces, ...baseConfig } = rootPkg.config
-
   // Include all by default
+  const { workspaces } = rootPkg.config
   const include = (name) => Array.isArray(workspaces) ? workspaces.includes(name) : true
 
   // Look through all workspaces on the root pkg
-  const rootWorkspaces = await mapWorkspaces({ pkg: rootPkg.pkg, cwd: root })
+  const rootWorkspaces = await mapWorkspaces({ pkg: rootPkg.pkgJson, cwd: root })
 
   for (const [wsName, wsPath] of rootWorkspaces.entries()) {
     if (include(wsName)) {
       // A workspace can control its own workspaceRepo and workspaceModule settings
       // which are true by default on the root config
-      wsPkgs.push(await getPkg(wsPath, baseConfig))
+      wsPkgs.push(await getPkg(wsPath))
     }
   }
 
@@ -67,19 +64,19 @@ const runAll = async (root, checks) => {
   const results = []
   const { pkgs, workspaces, rootPkg: { config: rootConfig } } = await getPkgs(root)
 
-  for (const { pkg, path, config: pkgConfig } of pkgs) {
+  for (const { pkgJson, path, config: pkgConfig } of pkgs) {
     // full config includes original config values
     const fullConfig = await getConfig({
       root,
       path,
-      pkg,
+      pkgJson,
       pkgs,
       workspaces,
       rootConfig,
       pkgConfig,
     })
 
-    const options = { root, pkg, path, config: fullConfig }
+    const options = { root, path, pkg: pkgJson, config: fullConfig }
     log.verbose('run-all', options)
 
     // files can export multiple checks so flatten first

package/lib/release-please/index.js

@@ -26,13 +26,34 @@ const main = async ({ repo: fullRepo, token, dryRun, branch }) => {
   )
 
   const pullRequests = await (dryRun ? manifest.buildPullRequests() : manifest.createPullRequests())
-  const releases = await (dryRun ? manifest.buildReleases() : manifest.createReleases())
+  const 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]
+  if (rootPr?.number) {
+    const commits = await github.octokit.paginate(github.octokit.rest.pulls.listCommits, {
+      owner: github.repository.owner,
+      repo: github.repository.repo,
+      pull_number: rootPr.number,
+    })
+    rootPr.sha = commits?.[commits.length - 1]?.sha
+  }
+
+  const releases = allReleases.filter(Boolean)
+  const [rootRelease, workspaceReleases] = releases.reduce((acc, r) => {
+    if (r.path === '.') {
+      acc[0] = r
+    } else {
+      acc[1].push(r)
+    }
+    return acc
+  }, [null, []])
 
   return {
-    // We only ever get a single pull request with our current release-please settings
-    pr: pullRequests.filter(Boolean)[0],
-    releases: releases.filter(Boolean),
-    release: releases.find(r => r.path === '.'),
+    pr: rootPr,
+    release: rootRelease,
+    releases: releases.length ? releases : null,
+    workspaceReleases: workspaceReleases.length ? workspaceReleases : null,
   }
 }
 

package/lib/util/files.js

@@ -23,18 +23,20 @@ const fileEntries = (dir, files, options) => Object.entries(files)
 // given an obj of files, return the full target/source paths and associated parser
 const getParsers = (dir, files, options) => {
   const parsers = fileEntries(dir, files, options).map(([target, source]) => {
-    const { file, parser, filter } = source
+    const { file, parser, filter, clean: shouldClean } = source
 
     if (typeof filter === 'function' && !filter(options)) {
       return null
     }
 
+    const clean = typeof shouldClean === 'function' ? shouldClean(options) : false
+
     if (parser) {
     // allow files to extend base parsers or create new ones
-      return new (parser(Parser.Parsers))(target, file, options)
+      return new (parser(Parser.Parsers))(target, file, options, { clean })
     }
 
-    return new (Parser(file))(target, file, options)
+    return new (Parser(file))(target, file, options, { clean })
   })
 
   return parsers.filter(Boolean)