@npmcli/template-oss 4.14.1 → 4.15.0

package/bin/release-manager.js

@@ -63,7 +63,7 @@ const DEFAULT_RELEASE_PROCESS = (args.publish ? AUTO_PUBLISH_STEPS : MANUAL_PUBL
     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 -R {NWO} -w release -b <BASE-BRANCH> -L 1 --json databaseId -q ".[0].databaseId"\`
+    gh run watch -R {NWO} $(gh run list -R {NWO} -w release -b <BASE-BRANCH> -L 1 --json databaseId -q ".[0].databaseId")
     \`\`\`
 `
 /* eslint-enable max-len */

package/lib/content/CONTRIBUTING.md

@@ -0,0 +1,48 @@
+# Contributing
+
+## Code of Conduct
+
+All interactions in the **npm** organization on GitHub are considered to be covered by our standard [Code of Conduct](https://docs.npmjs.com/policies/conduct).
+
+## Reporting Bugs
+
+Before submitting a new bug report please search for an existing or similar report.
+
+Use one of our existing issue templates if you believe you've come across a unique problem.
+
+Duplicate issues, or issues that don't use one of our templates may get closed without a response.
+
+## Pull Request Conventions
+
+### Commits
+
+We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
+
+When opening a pull request please be sure that either the pull request title, or each commit in the pull request, has one of the following prefixes:
+
+ - `feat`: For when introducing a new feature.  The result will be a new semver minor version of the package when it is next published.
+ - `fix`: For bug fixes. The result will be a new semver patch version of the package when it is next published.
+ - `docs`: For documentation updates.  The result will be a new semver patch version of the package when it is next published.
+ - `chore`: For changes that do not affect the published module.  Often these are changes to tests.  The result will be *no* change to the version of the package when it is next published (as the commit does not affect the published version).
+
+### Test Coverage
+
+Pull requests made against this repo will run `npm test` automatically.  Please make sure tests pass locally before submitting a PR.
+
+Every new feature or bug fix should come with a corresponding test or tests that validate the solutions. Testing also reports on code coverage and will fail if code coverage drops.
+
+### Linting
+
+Linting is also done automatically once tests pass.  `npm run lintfix` will fix most linting errors automatically.
+
+Please make sure linting passes before submitting a PR.
+
+## What _not_ to contribute?
+
+### Dependencies
+
+It should be noted that our team does not accept third-party dependency updates/PRs.  If you submit a PR trying to update our dependencies we will close it with or without a reference to these contribution guidelines.
+
+### Tools/Automation
+
+Our core team is responsible for the maintenance of the tooling/automation in this project and we ask contributors to not make changes to these when contributing (e.g. `.github/*`, `.eslintrc.json`, `.licensee.json`).  Most of those files also have a header at the top to remind folks they are automatically generated.  Pull requests that alter these will not be accepted.

package/lib/content/_step-checks.yml

@@ -34,7 +34,7 @@
       return { summary }
 {{/if}}
 - name: {{#if jobCheck.sha}}Create{{else}}Conclude{{/if}} Check
-  uses: LouisBrunner/checks-action@v1.3.1
+  uses: LouisBrunner/checks-action@v1.6.0
   {{#if jobCheck.sha}}
   id: check
   if: {{ jobCheck.sha }}

package/lib/content/index.js

@@ -49,6 +49,9 @@ const sharedRootAdd = (name) => ({
   '.github/workflows/post-dependabot.yml': {
     file: 'post-dependabot.yml',
   },
+  '.github/settings.yml': {
+    file: 'settings.yml',
+  },
 })
 
 const sharedRootRm = () => ({
@@ -87,6 +90,7 @@ const rootModule = {
     '.npmrc': 'npmrc',
     'SECURITY.md': 'SECURITY.md',
     'CODE_OF_CONDUCT.md': 'CODE_OF_CONDUCT.md',
+    'CONTRIBUTING.md': 'CONTRIBUTING.md',
     'package.json': 'pkg.json',
   },
   rm: [

package/lib/content/pull-request.yml

@@ -18,5 +18,7 @@ jobs:
           {{ 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 '$\{{ github.event.pull_request.title }}' | {{ rootNpxPath }} --offline commitlint -V
+          echo '$PR_TITLE' | {{ rootNpxPath }} --offline commitlint -V

package/lib/content/settings.yml

@@ -0,0 +1,24 @@
+repository:
+  allow_merge_commit: false
+  allow_rebase_merge: true
+  allow_squash_merge: true
+  squash_merge_commit_title: PR_TITLE
+  squash_merge_commit_message: PR_BODY
+  delete_branch_on_merge: true
+  enable_automated_security_fixes: true
+  enable_vulnerability_alerts: true
+
+branches:
+  {{#each branches}}
+  - name: {{ . }}
+    protection:
+      required_pull_request_reviews:
+        required_pull_request_review_count: 1
+        dismiss_stale_reviews: true
+        require_code_owner_reviews: true
+      restrictions:
+        teams:
+          - "npm/cli-team"
+      enforce_admins: true
+      required_status_checks: null
+  {{/each}}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@npmcli/template-oss",
-  "version": "4.14.1",
+  "version": "4.15.0",
   "description": "templated files used in npm CLI team oss projects",
   "main": "lib/content/index.js",
   "bin": {