feat(actions): simplify workflows and jobs (#1257)

BREAKING CHANGE: The "commitlint" workflow is unified into the "test" workflow and removed.

.github/workflows/test.yml

@@ -11,16 +11,37 @@ jobs:
     name: "test on node ${{ matrix.node-version }}"
     runs-on: ubuntu-latest
     strategy:
+      fail-fast: false
       matrix:
         node-version: ["14", "16", "18"]
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
-          cache: "npm"
+          cache: npm
+      - run: npm --global install npm@latest
+      - run: npm ci
+      - run: npm test --ignore-scripts
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: "lts/*"
+          cache: npm
       - run: npm --global install npm@latest
       - run: npm ci
       - run: npm run lint
-      - run: npm test
-      - run: npm run release:dry-run
+
+  commitlint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: wagoid/commitlint-github-action@v4
+        with:
+          configFile: package.json

lib/init.js

@@ -147,7 +147,6 @@ export async function init({ cwd = process.cwd(), logger = defaultLogger } = {})
   await cmd.updatePackageFile();
   await cmd.writePackageFile(".editorconfig");
   await cmd.writePackageFile(".remarkignore");
-  await cmd.writePackageFile(".github", "workflows", "commitlint.yml");
   await cmd.writePackageFile(".github", "workflows", "npm-audit-fix.yml");
   await cmd.writePackageFile(".github", "workflows", "npm-diff.yml");
   await cmd.writePackageFile(".github", "workflows", "release.yml");

package.json

@@ -20,7 +20,6 @@
     "types",
     ".editorconfig",
     ".remarkignore",
-    ".github/workflows/commitlint.yml",
     ".github/workflows/npm-audit-fix.yml",
     ".github/workflows/npm-diff.yml",
     ".github/workflows/release.yml",

test/__snapshots__/init.test.js.snap

@@ -155,28 +155,6 @@ trim_trailing_spaces = false
 "
 `;
 
-exports[`write ".github/workflows/commitlint.yml" 1`] = `
-"name: commitlint
-
-on:
-  push:
-    branches: [\\"main\\"]
-  pull_request:
-    branches: [\\"**\\"]
-
-jobs:
-  commitlint:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-      - uses: wagoid/commitlint-github-action@v4
-        with:
-          configFile: package.json
-"
-`;
-
 exports[`write ".github/workflows/npm-audit-fix.yml" 1`] = `
 "name: npm audit fix
 
@@ -239,19 +217,40 @@ jobs:
     name: \\"test on node \${{ matrix.node-version }}\\"
     runs-on: ubuntu-latest
     strategy:
+      fail-fast: false
       matrix:
         node-version: [\\"14\\", \\"16\\", \\"18\\"]
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
           node-version: \${{ matrix.node-version }}
-          cache: \\"npm\\"
+          cache: npm
+      - run: npm --global install npm@latest
+      - run: npm ci
+      - run: npm test --ignore-scripts
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: \\"lts/*\\"
+          cache: npm
       - run: npm --global install npm@latest
       - run: npm ci
       - run: npm run lint
-      - run: npm test
-      - run: npm run release:dry-run
+
+  commitlint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: wagoid/commitlint-github-action@v4
+        with:
+          configFile: package.json
 "
 `;
 

test/init.test.js

@@ -53,7 +53,6 @@ test('update "package.json" without fields', () =>
 [
   ".editorconfig",
   ".remarkignore",
-  ".github/workflows/commitlint.yml",
   ".github/workflows/npm-audit-fix.yml",
   ".github/workflows/release.yml",
   ".github/workflows/test.yml",
@@ -89,7 +88,6 @@ test("End-to-End via CLI", () =>
 "=> 'package.json' was updated
 => '.editorconfig' was updated
 => '.remarkignore' was updated
-=> '.github/workflows/commitlint.yml' was updated
 => '.github/workflows/npm-audit-fix.yml' was updated
 => '.github/workflows/npm-diff.yml' was updated
 => '.github/workflows/release.yml' was updated