feat: update generator to support Node policy #431

This commit updates the generator to not only use the current Node version setting in the package.json to populate the template files with the appropriate node version, but update to support the next LTS version using the new `abstractNodeVersionNext` variable. The updated template files are done to reflect thispolicy https://auro.alaskaair.com/node-support Changes to be committed: modified: .github/settings.yml modified: .github/workflows/testPublish.yml modified: bin/generate.js modified: template/.github/settings.yml modified: template/.github/workflows/testPublish.yml modified: template/package.json
AlaskaAirlines · Nov 16, 2023 · 9b2d3dc · 9b2d3dc
1 parent 4a488a1
commit 9b2d3dc
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 9 deletions.
diff --git a/.github/settings.yml b/.github/settings.yml
@@ -55,7 +55,7 @@ branches:
         # Required. Require branches to be up to date before merging.
         strict: true
         # Required. The list of status checks to require in order to merge into this branch
-        contexts: ["test (18.x)", "license/cla"]
+        contexts: ["test (18.x)", "test (20.x)", "license/cla"]
       # Required. Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.
       enforce_admins: false
       # Required. Restrict who can push to this branch. Team and user restrictions are only available for organization-owned repositories. Set to null to disable.
@@ -82,7 +82,7 @@ branches:
         # Required. Require branches to be up to date before merging.
         strict: true
         # Required. The list of status checks to require in order to merge into this branch
-        contexts: ["test (18.x)", "license/cla"]
+        contexts: ["test (18.x)", "test (20.x)", "license/cla"]
       # Required. Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.
       enforce_admins: false
       # Required. Restrict who can push to this branch. Team and user restrictions are only available for organization-owned repositories. Set to null to disable.

diff --git a/.github/workflows/testPublish.yml b/.github/workflows/testPublish.yml
@@ -15,7 +15,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [18.x]
+        node-version: [18.x, 20.x]
 
     steps:
       - uses: actions/checkout@v3
@@ -37,7 +37,7 @@ jobs:
           persist-credentials: false
       - uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 20.x
       - run: npm ci
       - run: npm run build:docs
       - uses: cycjimmy/semantic-release-action@v3

diff --git a/bin/generate.js b/bin/generate.js
@@ -257,6 +257,7 @@ const getReplacements = async ({ name, namespace, npm }) => {
   // Retrieve Node version defined in package.json
   const minNodeVersion = pjson.engines.node.replace(/[^0-9,.]+/g,'');
   const abstractNodeVersion = minNodeVersion.split('.')[0] + '.x';
+  const abstractNodeVersionNext = Number(minNodeVersion.split('.')[0]) + 2 + '.x';
 
   const nameReplacements = [
     { regex: /\[genVersion\]/g, value: pjson.version },
@@ -271,7 +272,8 @@ const getReplacements = async ({ name, namespace, npm }) => {
     { regex: /\[designTokens\]/g, value: versionData['@aurodesignsystem/design-tokens'] },
     { regex: /\[wcss\]/g, value: versionData['@aurodesignsystem/webcorestylesheets'] },
     { regex: /\[nodeVersion\]/g, value: minNodeVersion },
-    { regex: /\[abstractNodeVersion\]/g, value: abstractNodeVersion }
+    { regex: /\[abstractNodeVersion\]/g, value: abstractNodeVersion },
+    { regex: /\[abstractNodeVersionNext\]/g, value: abstractNodeVersionNext }
   ];
 
   return nameReplacements.concat(pkgReplacements);

diff --git a/template/.github/settings.yml b/template/.github/settings.yml
@@ -60,7 +60,7 @@ branches:
         # Required. Require branches to be up to date before merging.
         strict: true
         # Required. The list of status checks to require in order to merge into this branch
-        contexts: ["test ([abstractNodeVersion])", "license/cla"]
+        contexts: ["test ([abstractNodeVersion])","test ([abstractNodeVersionNext])", "license/cla"]
       # Required. Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.
       enforce_admins: false
       # Required. Restrict who can push to this branch. Team and user restrictions are only available for organization-owned repositories. Set to null to disable.

diff --git a/template/.github/workflows/testPublish.yml b/template/.github/workflows/testPublish.yml
@@ -15,7 +15,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [ [abstractNodeVersion] ]
+        node-version: [ [abstractNodeVersion], [abstractNodeVersionNext] ]
 
     steps:
       - uses: actions/checkout@v3
@@ -37,7 +37,7 @@ jobs:
           persist-credentials: false
       - uses: actions/setup-node@v3
         with:
-          node-version: [abstractNodeVersion]
+          node-version: [abstractNodeVersionNext]
       - run: npm ci
       - run: npm run build
       - uses: cycjimmy/semantic-release-action@v3

diff --git a/template/package.json b/template/package.json
@@ -16,7 +16,7 @@
   "main": "index.js",
   "license": "Apache-2.0",
   "engines": {
-    "node": ">=[nodeVersion]"
+    "node": "^[abstractNodeVersion] || ^[abstractNodeVersionNext] "
   },
   "dependencies": {
     "chalk": "",