@npmcli/template-oss 4.19.0 → 4.21.0

package/lib/content/index.js

@@ -5,48 +5,56 @@ const isPublic = (p) => p.config.isPublic
 const sharedRootAdd = (name) => ({
   // release
   '.github/workflows/release.yml': {
-    file: 'release.yml',
+    file: 'release-yml.hbs',
     filter: isPublic,
   },
   '.github/workflows/ci-release.yml': {
-    file: 'ci-release.yml',
+    file: 'ci-release-yml.hbs',
+    filter: isPublic,
+  },
+  '.github/workflows/release-integration.yml': {
+    file: 'release-integration-yml.hbs',
     filter: isPublic,
   },
   '.release-please-manifest.json': {
-    file: 'release-please-manifest.json',
+    file: 'release-please-manifest-json.hbs',
     filter: isPublic,
-    parser: (p) => class extends p.JsonMerge {
-      comment = null
-    },
+    parser: (p) => p.JsonMergeNoComment,
   },
   'release-please-config.json': {
-    file: 'release-please-config.json',
+    file: 'release-please-config-json.hbs',
     filter: isPublic,
-    parser: (p) => class extends p.JsonMerge {
-      comment = null
-    },
+    parser: (p) => p.JsonMergeNoComment,
+  },
+  'tsconfig.json': {
+    file: 'tsconfig-json.hbs',
+    filter: (p) => p.config.typescript,
+    parser: (p) => p.JsonMergeNoComment,
   },
   // this lint commits which is only necessary for releases
   '.github/workflows/pull-request.yml': {
-    file: 'pull-request.yml',
+    file: 'pull-request-yml.hbs',
     filter: isPublic,
   },
   // ci
-  '.github/matchers/tap.json': 'tap.json',
-  [`.github/workflows/ci${name ? `-${name}` : ''}.yml`]: 'ci.yml',
+  '.github/matchers/tap.json': 'tap-json.hbs',
+  [`.github/workflows/ci${name ? `-${name}` : ''}.yml`]: 'ci-yml.hbs',
   // dependabot
   '.github/dependabot.yml': {
-    file: 'dependabot.yml',
+    file: 'dependabot-yml.hbs',
     filter: (p) => p.config.dependabot,
   },
   '.github/workflows/post-dependabot.yml': {
-    file: 'post-dependabot.yml',
+    file: 'post-dependabot-yml.hbs',
     filter: (p) => p.config.dependabot,
   },
   '.github/settings.yml': {
-    file: 'settings.yml',
+    file: 'settings-yml.hbs',
     filter: (p) => !p.config.isReleaseBranch,
   },
+  // composite actions
+  '.github/actions/install-latest-npm/action.yml': 'action-install-latest-npm-yml.hbs',
+  '.github/actions/create-check/action.yml': 'action-create-check-yml.hbs',
 })
 
 const sharedRootRm = () => ({
@@ -61,15 +69,16 @@ const sharedRootRm = () => ({
 // Changes applied to the root of the repo
 const rootRepo = {
   add: {
-    '.commitlintrc.js': 'commitlintrc.js',
-    '.github/ISSUE_TEMPLATE/bug.yml': 'bug.yml',
-    '.github/ISSUE_TEMPLATE/config.yml': 'config.yml',
-    '.github/CODEOWNERS': 'CODEOWNERS',
-    '.github/workflows/audit.yml': 'audit.yml',
-    '.github/workflows/codeql-analysis.yml': 'codeql-analysis.yml',
+    '.commitlintrc.{{ cjsExt }}': 'commitlintrc-js.hbs',
+    '.github/ISSUE_TEMPLATE/bug.yml': 'bug-yml.hbs',
+    '.github/ISSUE_TEMPLATE/config.yml': 'config-yml.hbs',
+    '.github/CODEOWNERS': 'CODEOWNERS.hbs',
+    '.github/workflows/audit.yml': 'audit-yml.hbs',
+    '.github/workflows/codeql-analysis.yml': 'codeql-analysis-yml.hbs',
     ...sharedRootAdd(),
   },
   rm: {
+    '.commitlintrc.{{ deleteJsExt }}': true,
     '.github/workflows/release-test.yml': true,
     '.github/workflows/release-please.yml': true,
     ...sharedRootRm(),
@@ -83,19 +92,19 @@ const rootRepo = {
 // dir. so we might want to combine these
 const rootModule = {
   add: {
-    '.eslintrc.js': {
-      file: 'eslintrc.js',
+    '.eslintrc.{{ cjsExt }}': {
+      file: 'eslintrc-js.hbs',
       filter: (p) => p.config.eslint,
     },
-    '.gitignore': 'gitignore',
-    '.npmrc': 'npmrc',
-    'SECURITY.md': 'SECURITY.md',
-    'CODE_OF_CONDUCT.md': 'CODE_OF_CONDUCT.md',
-    'CONTRIBUTING.md': 'CONTRIBUTING.md',
-    'package.json': 'pkg.json',
+    '.gitignore': 'gitignore.hbs',
+    '.npmrc': 'npmrc.hbs',
+    'SECURITY.md': 'SECURITY-md.hbs',
+    'CODE_OF_CONDUCT.md': 'CODE_OF_CONDUCT-md.hbs',
+    'CONTRIBUTING.md': 'CONTRIBUTING-md.hbs',
+    'package.json': 'package-json.hbs',
   },
   rm: [
-    '.eslintrc.!(js|local.*)',
+    '.eslintrc.!({{ cjsExt }}|local.*)',
   ],
 }
 
@@ -114,16 +123,16 @@ const workspaceRepo = {
 // Changes for each workspace but applied to the relative workspace dir
 const workspaceModule = {
   add: {
-    '.eslintrc.js': {
-      file: 'eslintrc.js',
+    '.eslintrc.{{ cjsExt }}': {
+      file: 'eslintrc-js.hbs',
       filter: (p) => p.config.eslint,
     },
-    '.gitignore': 'gitignore',
-    'package.json': 'pkg.json',
+    '.gitignore': 'gitignore.hbs',
+    'package.json': 'package-json.hbs',
   },
   rm: [
     '.npmrc',
-    '.eslintrc.!(js|local.*)',
+    '.eslintrc.!({{ cjsExt }}|local.*)',
     'SECURITY.md',
   ],
 }
@@ -138,14 +147,16 @@ module.exports = {
   branches: ['main', 'latest'],
   // set this to the major version to backport
   backport: null,
+  // this tag will be used for publishing when not prerelease or backport. use
+  // {{major}} to have the major version being published replaced in the string.
+  defaultPublishTag: 'latest',
   releaseBranch: 'release/v*',
   distPaths: [
     'bin/',
     'lib/',
   ],
+  allowDistPaths: true,
   allowPaths: [
-    '/bin/',
-    '/lib/',
     '/.eslintrc.local.*',
     '**/.gitignore',
     '/docs/',
@@ -157,13 +168,17 @@ module.exports = {
     '/LICENSE*',
     '/CHANGELOG*',
   ],
-  ignorePaths: [],
+  ignorePaths: [
+    /* to be provided by consuming package */
+  ],
   ciVersions: {},
   latestCiVersion: 20,
   lockfile: false,
   codeowner: '@npm/cli-team',
   eslint: true,
   publish: false,
+  typescript: false,
+  esm: false,
   updateNpm: true,
   dependabot: 'increase-if-necessary',
   unwantedPackages: [
@@ -188,6 +203,6 @@ module.exports = {
     { type: 'fix', section: 'Bug Fixes', hidden: false },
     { type: 'docs', section: 'Documentation', hidden: false },
     { type: 'deps', section: 'Dependencies', hidden: false },
-    { type: 'chore', hidden: true },
+    { type: 'chore', section: 'Chores', hidden: false },
   ],
 }

package/lib/content/{pkg.json → package-json.hbs}

@@ -1,18 +1,22 @@
 {
   "author": "GitHub Inc.",
   "files": {{{ json distPaths }}},
+  "type": {{#if esm}}"module"{{else}}{{{ del }}}{{/if}},
   "scripts": {
-    "lint": "{{#if eslint}}eslint \"**/*.js\"{{else}}echo linting disabled{{/if}}",
+    "lint": "{{#if eslint}}eslint \"**/*.{js,cjs,ts,mjs,jsx,tsx}\"{{else}}echo linting disabled{{/if}}",
     "postlint": "template-oss-check",
     "template-oss-apply": "template-oss-apply --force",
     "lintfix": "{{ localNpmPath }} run lint -- --fix",
-    "snap": "tap",
-    "test": "tap",
+    "snap": "{{#if typescript}}{{#if tap16}}c8 {{/if}}{{/if}}tap",
+    "test": "{{#if typescript}}{{#if tap16}}c8 {{/if}}{{/if}}tap",
     "posttest": "{{ localNpmPath }} run lint",
     {{#if isRootMono}}
     "test-all": "{{ localNpmPath }} run test {{ allFlags }}",
     "lint-all": "{{ localNpmPath }} run lint {{ allFlags }}",
     {{/if}}
+    {{#if typescript}}
+    "prepare": "tshy",
+    {{/if}}
     "template-copy": {{{ del }}},
     "lint:fix": {{{ del }}},
     "preversion": {{{ del }}},
@@ -30,13 +34,23 @@
     {{#if workspacePaths}}
     "test-ignore": "^({{ join workspacePaths "|" }})/",
     {{/if}}
-    "nyc-arg": [
+    {{#if typescript}}
+    {{#if tap16}}
+    "coverage": false,
+    "node-arg": [
+      "--no-warnings",
+      "--loader",
+      "ts-node/esm"
+    ],
+    {{/if}}
+    {{/if}}
+    "nyc-arg": {{#if tap18}}{{{ del }}}{{else}}[
       {{#each workspaceGlobs}}
       "--exclude",
       "{{ . }}",
       {{/each}}
       "--exclude",
       "tap-snapshots/**"
-    ]
+    ]{{/if}}
   }
 }

package/lib/content/{post-dependabot.yml → post-dependabot-yml.hbs}

@@ -8,7 +8,7 @@ permissions:
 
 jobs:
   template-oss:
-    {{> job
+    {{> jobYml
       jobName="template-oss"
       jobIf="github.actor == 'dependabot[bot]'"
       jobCheckout=(obj ref="${{ github.event.pull_request.head.ref }}")

package/lib/content/{pull-request.yml → pull-request-yml.hbs}

@@ -10,15 +10,13 @@ on:
 
 jobs:
   commitlint:
-    {{> job jobName="Lint Commits" jobCheckout=(obj fetch-depth=0) }}
+    {{> jobYml 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/$\{{ github.base_ref }}' --to $\{{ github.event.pull_request.head.sha }}
+        run: {{ 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'
         env:
           PR_TITLE: $\{{ github.event.pull_request.title }}
-        run: |
-          echo "$PR_TITLE" | {{ rootNpxPath }} --offline commitlint -V
+        run: echo "$PR_TITLE" | {{ rootNpxPath }} --offline commitlint -V

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

@@ -0,0 +1,24 @@
+name: Release Integration
+
+on:
+  workflow_dispatch:
+    inputs:
+      releases:
+        required: true
+        type: string
+        description: 'A json array of releases. Required fields: publish: tagName, publishTag. publish check: pkgName, version'
+  workflow_call:
+    inputs:
+      releases:
+        required: true
+        type: string
+        description: 'A json array of releases. Required fields: publish: tagName, publishTag. publish check: pkgName, version'
+    {{#if publish}}
+    secrets:
+      PUBLISH_TOKEN:
+        required: true
+    {{/if}} 
+
+jobs:
+  publish:
+    {{> jobReleaseIntegrationYml }}

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

@@ -0,0 +1,23 @@
+{
+  "separate-pull-requests": {{{ del }}},
+  {{#if isMonoPublic }}
+  "plugins": [
+    "node-workspace",
+    "node-workspace-format"
+  ],
+  {{/if}}
+  "exclude-packages-from-root": {{{ del }}},
+  "group-pull-request-title-pattern": "chore: release ${version}",
+  "pull-request-title-pattern": "chore: release${component} ${version}",
+  "changelog-sections": {{{ json changelogTypes }}},
+  "prerelease-type": "pre",
+  "packages": {
+    "{{ pkgPath }}": {
+      {{#if isRoot}}
+      "package-name": ""{{#if workspacePaths}},
+      "exclude-paths": {{{ json workspacePaths }}}
+      {{/if}}
+      {{/if}}
+    }
+  }
+}

package/lib/content/release-yml.hbs

@@ -0,0 +1,245 @@
+name: Release
+
+on:
+  push:
+    branches:
+      {{#each branchPatterns}}
+      - {{ . }}
+      {{/each}}
+
+permissions:
+  contents: write
+  pull-requests: write
+  checks: write
+
+jobs:
+  release:
+    outputs:
+      pr: $\{{ steps.release.outputs.pr }}
+      pr-branch: $\{{ steps.release.outputs.pr-branch }}
+      pr-number: $\{{ steps.release.outputs.pr-number }}
+      pr-sha: $\{{ steps.release.outputs.pr-sha }}
+      releases: $\{{ steps.release.outputs.releases }}
+      comment-id: $\{{ steps.create-comment.outputs.comment-id || steps.update-comment.outputs.comment-id }}
+      check-id: $\{{ steps.create-check.outputs.check-id }}
+    {{> jobYml jobName="Release" }}
+      - name: Release Please
+        id: release
+        env:
+          GITHUB_TOKEN: $\{{ secrets.GITHUB_TOKEN }}
+        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
+        id: comment-text
+        with:
+          result-encoding: string
+          script: |
+            const { runId, repo: { owner, repo } } = context
+            const { data: workflow } = await github.rest.actions.getWorkflowRun({ owner, repo, run_id: runId })
+            return['## Release Manager', `Release workflow run: ${workflow.html_url}`].join('\n\n')
+      - name: Find Release Manager Comment
+        uses: peter-evans/find-comment@v2
+        if: steps.release.outputs.pr-number
+        id: found-comment
+        with:
+          issue-number: $\{{ steps.release.outputs.pr-number }}
+          comment-author: 'github-actions[bot]'
+          body-includes: '## Release Manager'
+      - name: Create Release Manager Comment
+        id: create-comment
+        if: steps.release.outputs.pr-number && !steps.found-comment.outputs.comment-id
+        uses: peter-evans/create-or-update-comment@v3
+        with:
+          issue-number: $\{{ steps.release.outputs.pr-number }}
+          body: $\{{ steps.comment-text.outputs.result }}
+      - name: Update Release Manager Comment
+        id: update-comment
+        if: steps.release.outputs.pr-number && steps.found-comment.outputs.comment-id
+        uses: peter-evans/create-or-update-comment@v3
+        with:
+          comment-id: $\{{ steps.found-comment.outputs.comment-id }}
+          body: $\{{ steps.comment-text.outputs.result }}
+          edit-mode: 'replace'
+      - name: Create Check
+        id: create-check
+        uses: ./.github/actions/create-check
+        if: steps.release.outputs.pr-sha
+        with:
+          name: "Release"
+          token: $\{{ secrets.GITHUB_TOKEN }}
+          sha: $\{{ steps.release.outputs.pr-sha }}
+
+  update:
+    needs: release
+    outputs:
+      sha: $\{{ steps.commit.outputs.sha }}
+      check-id: $\{{ steps.create-check.outputs.check-id }}
+    {{> jobYml
+      jobName="Update - Release"
+      jobIf="needs.release.outputs.pr"
+      jobCheckout=(obj ref="${{ needs.release.outputs.pr-branch }}" fetch-depth=0)
+    }}
+      - name: Create Release Manager Checklist Text
+        id: comment-text
+        env:
+          GITHUB_TOKEN: $\{{ secrets.GITHUB_TOKEN }}
+        run: {{ rootNpmPath }} exec --offline -- template-oss-release-manager --pr="$\{{ needs.release.outputs.pr-number }}" --backport="{{ backport }}" --defaultTag="{{ defaultPublishTag }}" {{~#if lockfile}} --lockfile{{/if}} {{~#if publish}} --publish{{/if}}
+      - name: Append Release Manager Comment
+        uses: peter-evans/create-or-update-comment@v3
+        with:
+          comment-id: $\{{ needs.release.outputs.comment-id }}
+          body: $\{{ steps.comment-text.outputs.result }}
+          edit-mode: 'append'
+      - name: Run Post Pull Request Actions
+        env:
+          GITHUB_TOKEN: $\{{ secrets.GITHUB_TOKEN }}
+        run: {{ rootNpmPath }} run rp-pull-request --ignore-scripts {{~#if allFlags}} {{ allFlags }}{{else}} --if-present{{/if}} -- --pr="$\{{ needs.release.outputs.pr-number }}" --commentId="$\{{ needs.release.outputs.comment-id }}"
+      - name: Commit
+        id: commit
+        env:
+          GITHUB_TOKEN: $\{{ secrets.GITHUB_TOKEN }}
+        run: |
+          git commit --all --amend --no-edit || true
+          git push --force-with-lease
+          echo "sha=$(git rev-parse HEAD)" >> $GITHUB_OUTPUT
+      - name: Create Check
+        id: create-check
+        uses: ./.github/actions/create-check
+        with:
+          name: "Update - Release"
+          check-name: "Release"
+          token: $\{{ secrets.GITHUB_TOKEN }}
+          sha: $\{{ steps.commit.outputs.sha }}
+      - name: Conclude Check
+        uses: LouisBrunner/checks-action@v1.6.0
+        with:
+          token: $\{{ secrets.GITHUB_TOKEN }}
+          conclusion: $\{{ job.status }}
+          check_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.pr-branch }}
+      check-sha: $\{{ needs.update.outputs.sha }}
+
+  post-ci:
+    needs: [release, update, ci]
+    {{> jobYml jobName="Post CI - Release" jobIf="needs.release.outputs.pr && always()" jobSkipSetup=true }}
+      - name: Get CI Conclusion
+        id: conclusion
+        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 "result=$result" >> $GITHUB_OUTPUT
+      - name: Conclude Check
+        uses: LouisBrunner/checks-action@v1.6.0
+        with:
+          token: $\{{ secrets.GITHUB_TOKEN }}
+          conclusion: $\{{ steps.conclusion.outputs.result }}
+          check_id: $\{{ needs.update.outputs.check-id }}
+
+  post-release:
+    needs: release
+    outputs:
+      comment-id: $\{{ steps.create-comment.outputs.comment-id }}
+    {{> 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
+        env:
+          RELEASES: $\{{ needs.release.outputs.releases }}
+        with:
+          result-encoding: string
+          script: |
+            const releases = JSON.parse(process.env.RELEASES)
+            const { runId, repo: { owner, repo } } = context
+            const issue_number = releases[0].prNumber
+            const runUrl = `https://github.com/${owner}/${repo}/actions/runs/${runId}`
+
+            return [
+              '## Release Workflow\n',
+              ...releases.map(r => `- \`${r.pkgName}@${r.version}\` ${r.url}`),
+              `- Workflow run: :arrows_counterclockwise: ${runUrl}`,
+            ].join('\n')
+      - name: Create Release PR Comment
+        id: create-comment
+        uses: peter-evans/create-or-update-comment@v3
+        with:
+          issue-number: $\{{ fromJSON(needs.release.outputs.releases)[0].prNumber }}
+          body: $\{{ steps.comment-text.outputs.result }}
+
+  release-integration:
+    needs: release
+    name: Release Integration
+    if: needs.release.outputs.releases
+    uses: ./.github/workflows/release-integration.yml
+    {{#if publish}}
+    permissions:
+      id-token: write
+    secrets:
+      PUBLISH_TOKEN: $\{{ secrets.PUBLISH_TOKEN }}
+    {{/if}}
+    with:
+      releases: $\{{ needs.release.outputs.releases }}
+
+  post-release-integration:
+    needs: [release, release-integration, post-release]
+    {{> jobYml jobName="Post Release Integration - Release" jobIf="needs.release.outputs.releases && always()" jobSkipSetup=true }}
+      - name: Get Post Release Conclusion
+        id: conclusion
+        run: |
+          if [[ "$\{{ contains(needs.*.result, 'failure') }}" == "true" ]]; then
+            result="x"
+          elif [[ "$\{{ contains(needs.*.result, 'cancelled') }}" == "true" ]]; then
+            result="heavy_multiplication_x"
+          else
+            result="white_check_mark"
+          fi
+          echo "result=$result" >> $GITHUB_OUTPUT
+      - name: Find Release PR Comment
+        uses: peter-evans/find-comment@v2
+        id: found-comment
+        with:
+          issue-number: $\{{ fromJSON(needs.release.outputs.releases)[0].prNumber }}
+          comment-author: 'github-actions[bot]'
+          body-includes: '## Release Workflow'
+      - name: Create Release PR Comment Text
+        id: comment-text
+        if: steps.found-comment.outputs.comment-id
+        uses: actions/github-script@v6
+        env:
+          RESULT: $\{{ steps.conclusion.outputs.result }}
+          BODY: $\{{ steps.found-comment.outputs.comment-body }}
+        with:
+          result-encoding: string
+          script: |
+            const { RESULT, BODY } = process.env
+            const body = [BODY.replace(/(Workflow run: :)[a-z_]+(:)/, `$1${RESULT}$2`)]
+            if (RESULT !== 'white_check_mark') {
+              body.push(':rotating_light::rotating_light::rotating_light:')
+              body.push([
+                '{{ codeowner }}: The post-release workflow failed for this release.',
+                'Manual steps may need to be taken after examining the workflow output.'
+              ].join(' '))
+              body.push(':rotating_light::rotating_light::rotating_light:')
+            }
+            return body.join('\n\n').trim()
+      - name: Update Release PR Comment
+        if: steps.comment-text.outputs.result
+        uses: peter-evans/create-or-update-comment@v3
+        with:
+          comment-id: $\{{ steps.found-comment.outputs.comment-id }}
+          body: $\{{ steps.comment-text.outputs.result }}
+          edit-mode: 'replace'
+            

package/lib/content/tsconfig-json.hbs

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "jsx": "react",
+    "declaration": true,
+    "declarationMap": true,
+    "inlineSources": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "moduleResolution": "nodenext",
+    "resolveJsonModule": true,
+    "skipLibCheck": true,
+    "sourceMap": true,
+    "strict": true,
+    "target": "es2022",
+    "module": "nodenext"
+  }
+}