refactor: move GitHub Actions to .yml file templates (#12)

Author: oscard0m

lib/create-github-action.js

@@ -0,0 +1,15 @@
+import writePrettyFile from "./write-pretty-file.js";
+import getTemplateFileContent from "./get-template-file-content.js";
+
+export default async function createGitHubAction(actionFileName, options = {}) {
+  let fileContent = getTemplateFileContent(`github-actions/${actionFileName}`);
+
+  if (options.replace) {
+    fileContent = fileContent.replace(
+      options.replace.searchValue,
+      options.replace.replaceValue
+    );
+  }
+
+  await writePrettyFile(`.github/workflows/${actionFileName}`, fileContent);
+}

lib/create-release-action.js

@@ -1,36 +1,13 @@
-import writePrettyFile from "./write-pretty-file.js";
+import createGitHubAction from "./create-github-action.js";
 
 export default async function createReleaseAction({ owner }) {
   const npmTokenSecretName =
     owner === "octoherd" ? "NPM_AUTOMATION_TOKEN" : "NPM_TOKEN";
-  await writePrettyFile(
-    ".github/workflows/release.yml",
-    `name: Release
-on:
-  push:
-    branches:
-      - main
 
-jobs:
-  release:
-    name: release
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
-        with:
-          node-version: 12
-      - uses: actions/cache@v1
-        with:
-          path: ~/.npm
-          key: \${{ runner.os }}-node-\${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            \${{ runner.os }}-node-
-      - run: npm ci
-      - run: npx semantic-release
-        env:
-          GITHUB_TOKEN: \${{ secrets.GITHUB_TOKEN }}
-          NPM_TOKEN: \${{ secrets.${npmTokenSecretName} }}
-`
-  );
+  await createGitHubAction("release.yml", {
+    replace: {
+      searchValue: "__npmTokenSecretName__",
+      replaceValue: npmTokenSecretName,
+    },
+  });
 }

lib/create-test-action.js

@@ -1,45 +1,5 @@
-import writePrettyFile from "./write-pretty-file.js";
+import createGitHubAction from "./create-github-action.js";
 
 export default async function createTestAction() {
-  await writePrettyFile(
-    ".github/workflows/test.yml",
-    `name: Test
-on:
-  push:
-    branches:
-      - main
-  pull_request:
-    types: [opened, synchronize]
-
-jobs:
-  test_matrix:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node_version: ["12", "14"]
-
-    steps:
-      - uses: actions/checkout@v2
-      - name: Use Node.js \${{ matrix.node_version }}
-        uses: actions/setup-node@v2
-        with:
-          node-version: \${{ matrix.node_version }}
-      - uses: actions/cache@v2
-        with:
-          path: ~/.npm
-          key: \${{ runner.os }}-node-\${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            \${{ runner.os }}-node-
-      - run: npm ci
-      - run: npm test
-    
-  # The "test" step can be required in branch protection and does not
-  # change each time the test matrix changes.
-  test:
-    runs-on: ubuntu-latest
-    needs: test_matrix
-    steps:
-      - run: echo ok
-`
-  );
+  await createGitHubAction("test.yml");
 }

templates/github-actions/release.yml

@@ -0,0 +1,26 @@
+name: Release
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  release:
+    name: release
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 12
+      - uses: actions/cache@v1
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
+      - run: npm ci
+      - run: npx semantic-release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.__npmTokenSecretName__ }}

templates/github-actions/test.yml

@@ -0,0 +1,37 @@
+name: Test
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types: [opened, synchronize]
+
+jobs:
+  test_matrix:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node_version: ["12", "14"]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node_version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node_version }}
+      - uses: actions/cache@v2
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
+      - run: npm ci
+      - run: npm test
+    
+  # The "test" step can be required in branch protection and does not
+  # change each time the test matrix changes.
+  test:
+    runs-on: ubuntu-latest
+    needs: test_matrix
+    steps:
+      - run: echo ok