feat: add release process scripts (#20)

* feat: add release process scripts Adds dependabot config, dev dependencies get a `chore` prefix. Ignores package-lock.json in git. Adds npmrc that disables package-lock by default. Add periodic npm audit action. Add periodic check to ci.yml. Add release-please action. Add PR linting action, lints PR commit messages OR title. Co-authored-by: Nathan Fritz <[email protected]> Co-authored-by: Luke Karrys <[email protected]>
npm · Dec 14, 2021 · af7b9f5 · af7b9f5
1 parent 1294318
commit af7b9f5
Show file tree

Hide file tree

Showing 18 changed files with 230 additions and 14,058 deletions.
diff --git a/.commitlintrc.js b/.commitlintrc.js
@@ -0,0 +1,11 @@
+// This file is automatically added by @npmcli/template-oss. Do not edit.
+
+module.exports = {
+  extends: ['@commitlint/config-conventional'],
+  // If you change rules be sure to also update release-please.yml
+  rules: {
+    'type-enum': [2, 'always', ['feat', 'fix', 'docs', 'chore', 'deps']],
+    'header-max-length': [2, 'always', 80],
+    'subject-case': [2, 'always', ['lower-case', 'sentence-case', 'start-case']],
+  },
+}
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,16 @@
+# This file is automatically added by @npmcli/template-oss. Do not edit.
+
+version: 2
+updates:
+- package-ecosystem: npm
+  directory: "/"
+  schedule:
+    interval: daily
+  allow:
+    - dependency-type: direct
+  versioning-strategy: increase-if-necessary
+  commit-message:
+    prefix: deps
+    prefix-development: chore
+  labels:
+    - "dependencies"
diff --git a/.github/workflows/audit.yml b/.github/workflows/audit.yml
@@ -0,0 +1,23 @@
+# This file is automatically added by @npmcli/template-oss. Do not edit.
+
+name: Audit
+
+on:
+  schedule:
+    # "At 01:00 on Monday" https://crontab.guru/#0_1_*_*_1
+    - cron: "0 1 * * 1"
+  workflow_dispatch:
+
+jobs:
+  audit:
+    name: npm audit
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '16'
+      - name: Install deps
+        run: npm i --package-lock
+      - name: Audit
+        run: npm audit
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -8,6 +8,9 @@ on:
     branches:
       - main
       - latest
+  schedule:
+    # "At 02:00 on Monday" https://crontab.guru/#0_1_*_*_1
+    - cron: "0 2 * * 1"
 
 jobs:
   lint:
@@ -17,9 +20,8 @@ jobs:
       - uses: actions/setup-node@v2
         with:
           node-version: '16'
-          cache: npm
       - run: npm i --prefer-online -g npm@latest
-      - run: npm ci
+      - run: npm i
       - run: npm run lint
 
   test:
@@ -47,7 +49,6 @@ jobs:
       - uses: actions/setup-node@v2
         with:
           node-version: ${{ matrix.node-version }}
-          cache: npm
       - run: npm i --prefer-online -g npm@latest
-      - run: npm ci
+      - run: npm i
       - run: npm test --ignore-scripts
diff --git a/.github/workflows/pull-request.yml b/.github/workflows/pull-request.yml
@@ -0,0 +1,27 @@
+# This file is automatically added by @npmcli/template-oss. Do not edit.
+
+name: Pull Request Linting
+
+on:
+  pull_request:
+    types: [opened, reopened, edited, synchronize]
+
+jobs:
+  check:
+    name: Check PR Title or Commits
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '16'
+      - name: Install deps
+        run: |
+          npm i -D @commitlint/cli @commitlint/config-conventional
+      - name: Check commits OR PR title
+        env:
+          PR_TITLE: ${{ github.event.pull_request.title }}
+        run: |
+          npx commitlint -x @commitlint/config-conventional -V --from origin/main --to ${{ github.event.pull_request.head.sha }} || echo $PR_TITLE | npx commitlint -x @commitlint/config-conventional -V
diff --git a/.github/workflows/release-please.yml b/.github/workflows/release-please.yml
@@ -0,0 +1,25 @@
+# This file is automatically added by @npmcli/template-oss. Do not edit.
+
+name: Release Please
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: google-github-actions/release-please-action@v2
+        id: release
+        with:
+          package-name: conventional-test
+          release-type: node
+          # If you change changelog-types be sure to also update commitlintrc.js
+          changelog-types: >
+            [{"type":"feat","section":"Features","hidden":false},
+            {"type":"fix","section":"Bug Fixes","hidden":false},
+            {"type":"docs","section":"Documentation","hidden":false},
+            {"type":"deps","section":"dependencies","hidden":false},
+            {"type":"chore","hidden":true}]
diff --git a/.gitignore b/.gitignore
@@ -4,11 +4,12 @@
 /*
 
 # keep these
+!/.commitlintrc.js
+!/.npmrc
 !/.eslintrc*
 !/.github
 !**/.gitignore
 !/package.json
-!/package-lock.json
 !/docs
 !/bin
 !/lib

diff --git a/.npmrc b/.npmrc
@@ -0,0 +1,3 @@
+;This file is automatically added by @npmcli/template-oss. Do not edit.
+
+package-lock=false
diff --git a/lib/content/audit.yml b/lib/content/audit.yml
@@ -0,0 +1,23 @@
+# This file is automatically added by @npmcli/template-oss. Do not edit.
+
+name: Audit
+
+on:
+  schedule:
+    # "At 01:00 on Monday" https://crontab.guru/#0_1_*_*_1
+    - cron: "0 1 * * 1"
+  workflow_dispatch:
+
+jobs:
+  audit:
+    name: npm audit
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '16'
+      - name: Install deps
+        run: npm i --package-lock
+      - name: Audit
+        run: npm audit
diff --git a/lib/content/ci.yml b/lib/content/ci.yml
@@ -8,6 +8,9 @@ on:
     branches:
       - main
       - latest
+  schedule:
+    # "At 02:00 on Monday" https://crontab.guru/#0_1_*_*_1
+    - cron: "0 2 * * 1"
 
 jobs:
   lint:
@@ -17,9 +20,8 @@ jobs:
       - uses: actions/setup-node@v2
         with:
           node-version: '16'
-          cache: npm
       - run: npm i --prefer-online -g npm@latest
-      - run: npm ci
+      - run: npm i
       - run: npm run lint
 
   test:
@@ -47,7 +49,6 @@ jobs:
       - uses: actions/setup-node@v2
         with:
           node-version: ${{ matrix.node-version }}
-          cache: npm
       - run: npm i --prefer-online -g npm@latest
-      - run: npm ci
+      - run: npm i
       - run: npm test --ignore-scripts
diff --git a/lib/content/commitlintrc.js b/lib/content/commitlintrc.js
@@ -0,0 +1,11 @@
+// This file is automatically added by @npmcli/template-oss. Do not edit.
+
+module.exports = {
+  extends: ['@commitlint/config-conventional'],
+  // If you change rules be sure to also update release-please.yml
+  rules: {
+    'type-enum': [2, 'always', ['feat', 'fix', 'docs', 'chore', 'deps']],
+    'header-max-length': [2, 'always', 80],
+    'subject-case': [2, 'always', ['lower-case', 'sentence-case', 'start-case']],
+  },
+}
diff --git a/lib/content/dependabot.yml b/lib/content/dependabot.yml
@@ -0,0 +1,16 @@
+# This file is automatically added by @npmcli/template-oss. Do not edit.
+
+version: 2
+updates:
+- package-ecosystem: npm
+  directory: "/"
+  schedule:
+    interval: daily
+  allow:
+    - dependency-type: direct
+  versioning-strategy: increase-if-necessary
+  commit-message:
+    prefix: deps
+    prefix-development: chore
+  labels:
+    - "dependencies"
diff --git a/lib/content/gitignore b/lib/content/gitignore
@@ -4,11 +4,12 @@
 /*
 
 # keep these
+!/.commitlintrc.js
+!/.npmrc
 !/.eslintrc*
 !/.github
 !**/.gitignore
 !/package.json
-!/package-lock.json
 !/docs
 !/bin
 !/lib

diff --git a/lib/content/npmrc b/lib/content/npmrc
@@ -0,0 +1,3 @@
+;This file is automatically added by @npmcli/template-oss. Do not edit.
+
+package-lock=false
diff --git a/lib/content/pull-request.yml b/lib/content/pull-request.yml
@@ -0,0 +1,27 @@
+# This file is automatically added by @npmcli/template-oss. Do not edit.
+
+name: Pull Request Linting
+
+on:
+  pull_request:
+    types: [opened, reopened, edited, synchronize]
+
+jobs:
+  check:
+    name: Check PR Title or Commits
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '16'
+      - name: Install deps
+        run: |
+          npm i -D @commitlint/cli @commitlint/config-conventional
+      - name: Check commits OR PR title
+        env:
+          PR_TITLE: ${{ github.event.pull_request.title }}
+        run: |
+          npx commitlint -x @commitlint/config-conventional -V --from origin/main --to ${{ github.event.pull_request.head.sha }} || echo $PR_TITLE | npx commitlint -x @commitlint/config-conventional -V
diff --git a/lib/content/release-please.yml b/lib/content/release-please.yml
@@ -0,0 +1,25 @@
+# This file is automatically added by @npmcli/template-oss. Do not edit.
+
+name: Release Please
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: google-github-actions/release-please-action@v2
+        id: release
+        with:
+          package-name: conventional-test
+          release-type: node
+          # If you change changelog-types be sure to also update commitlintrc.js
+          changelog-types: >
+            [{"type":"feat","section":"Features","hidden":false},
+            {"type":"fix","section":"Bug Fixes","hidden":false},
+            {"type":"docs","section":"Documentation","hidden":false},
+            {"type":"deps","section":"dependencies","hidden":false},
+            {"type":"chore","hidden":true}]
diff --git a/lib/postinstall/copy-content.js b/lib/postinstall/copy-content.js
@@ -9,14 +9,20 @@ const contentDir = resolve(__dirname, '..', 'content')
 const moduleFiles = {
   '.eslintrc.js': './eslintrc.js',
   '.gitignore': './gitignore',
+  '.npmrc': './npmrc',
   'SECURITY.md': './SECURITY.md',
 }
 
 const repoFiles = {
+  '.commitlintrc.js': './commitlintrc.js',
   '.github/workflows/ci.yml': './ci.yml',
   '.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/pull-request.yml': './pull-request.yml',
+  '.github/workflows/release-please.yml': './release-please.yml',
 }
 
 // currently no workspace moduleFiles