feat(node-version): set the reusable workflow for release based on node version

since projects that are using older node versions dont support the use of the latest version of
semantic-release

Author: travi

src/semantic-release/ci-providers/github-workflows/lifter-test.js

@@ -7,6 +7,7 @@ import {assert} from 'chai';
 import sinon from 'sinon';
 
 import * as releaseTriggerNeeds from './release-trigger-needs';
+import * as reusableReleaseWorkflow from './reusable-release-workflow';
 import * as releaseWorkflowLifter from './release-workflow-for-alpha/lifter';
 import lift from './lifter';
 
@@ -22,9 +23,10 @@ suite('github-workflows lifter for semantic-release', () => {
   const branchTriggers = any.listOf(any.word);
   const moreBranchTriggers = any.listOf(any.word);
   const neededJobsToTriggerRelease = any.listOf(any.word);
+  const reusableReleaseWorkflowReference = any.string();
   const modernReleaseJobDefinition = {
     needs: neededJobsToTriggerRelease,
-    uses: 'form8ion/.github/.github/workflows/release-package.yml@master',
+    uses: reusableReleaseWorkflowReference,
     // eslint-disable-next-line no-template-curly-in-string
     secrets: {NPM_TOKEN: '${{ secrets.NPM_PUBLISH_TOKEN }}'}
   };
@@ -37,10 +39,14 @@ suite('github-workflows lifter for semantic-release', () => {
     sandbox.stub(core, 'writeConfigFile');
     sandbox.stub(releaseWorkflowLifter, 'default');
     sandbox.stub(releaseTriggerNeeds, 'default');
+    sandbox.stub(reusableReleaseWorkflow, 'determineAppropriateWorkflow');
 
     const commonVerificationWorkflowContents = any.string();
     fs.readFile.withArgs(`${workflowsDirectory}/node-ci.yml`, 'utf-8').resolves(commonVerificationWorkflowContents);
     jsYaml.load.withArgs(commonVerificationWorkflowContents).returns({on: {push: {branches: []}}, jobs: {}});
+    reusableReleaseWorkflow.determineAppropriateWorkflow
+      .withArgs(nodeVersion)
+      .returns(reusableReleaseWorkflowReference);
   });
 
   teardown(() => sandbox.restore());
@@ -117,7 +123,7 @@ suite('github-workflows lifter for semantic-release', () => {
         jobs: existingJobs
       });
 
-    await lift({projectRoot});
+    await lift({projectRoot, nodeVersion});
 
     assert.calledWith(
       core.writeConfigFile,
@@ -156,7 +162,7 @@ suite('github-workflows lifter for semantic-release', () => {
         jobs: existingJobs
       });
 
-    await lift({projectRoot});
+    await lift({projectRoot, nodeVersion});
 
     assert.calledWith(
       core.writeConfigFile,
@@ -170,12 +176,7 @@ suite('github-workflows lifter for semantic-release', () => {
           jobs: {
             ...jobs,
             [jobNameContainingCycjimmyAction]: {steps: otherStepsInJobContainingCycJimmyAction},
-            release: {
-              needs: neededJobsToTriggerRelease,
-              uses: 'form8ion/.github/.github/workflows/release-package.yml@master',
-              // eslint-disable-next-line no-template-curly-in-string
-              secrets: {NPM_TOKEN: '${{ secrets.NPM_PUBLISH_TOKEN }}'}
-            }
+            release: modernReleaseJobDefinition
           }
         }
       }
@@ -193,7 +194,7 @@ suite('github-workflows lifter for semantic-release', () => {
         jobs
       });
 
-    await lift({projectRoot});
+    await lift({projectRoot, nodeVersion});
 
     assert.calledWith(
       core.writeConfigFile,
@@ -204,15 +205,7 @@ suite('github-workflows lifter for semantic-release', () => {
         config: {
           ...parsedVerificationWorkflowContents,
           on: {push: {branches: [...branchTriggers, ...moreBranchTriggers, 'beta']}},
-          jobs: {
-            ...jobs,
-            release: {
-              needs: neededJobsToTriggerRelease,
-              uses: 'form8ion/.github/.github/workflows/release-package.yml@master',
-              // eslint-disable-next-line no-template-curly-in-string
-              secrets: {NPM_TOKEN: '${{ secrets.NPM_PUBLISH_TOKEN }}'}
-            }
-          }
+          jobs: {...jobs, release: modernReleaseJobDefinition}
         }
       }
     );

src/semantic-release/ci-providers/github-workflows/lifter.js

@@ -4,6 +4,7 @@ import {fileTypes, writeConfigFile} from '@form8ion/core';
 
 import determineTriggerNeedsFrom from './release-trigger-needs';
 import {lift as liftReleaseWorkflow} from './release-workflow-for-alpha';
+import {determineAppropriateWorkflow} from './reusable-release-workflow';
 
 function removeCycjimmyActionFrom(otherJobs) {
   return Object.fromEntries(Object.entries(otherJobs).map(([jobName, job]) => [
@@ -33,7 +34,7 @@ export default async function ({projectRoot, nodeVersion}) {
     ...removeCycjimmyActionFrom(otherJobs),
     release: {
       needs: determineTriggerNeedsFrom(otherJobs),
-      uses: 'form8ion/.github/.github/workflows/release-package.yml@master',
+      uses: determineAppropriateWorkflow(nodeVersion),
       // eslint-disable-next-line no-template-curly-in-string
       secrets: {NPM_TOKEN: '${{ secrets.NPM_PUBLISH_TOKEN }}'}
     }

src/semantic-release/ci-providers/github-workflows/release-workflow-for-alpha/scaffolder-test.js

@@ -6,10 +6,12 @@ import {assert} from 'chai';
 import sinon from 'sinon';
 import any from '@travi/any';
 
+import * as reusableWorkflow from '../reusable-release-workflow';
 import scaffoldReleaseWorkflow from './scaffolder';
 
 suite('github release workflow scaffolder', () => {
   let sandbox;
+  const nodeVersion = any.string();
 
   setup(() => {
     sandbox = sinon.createSandbox();
@@ -19,6 +21,7 @@ suite('github release workflow scaffolder', () => {
     sandbox.stub(githubWorkflowsCore, 'scaffoldCheckoutStep');
     sandbox.stub(githubWorkflowsCore, 'scaffoldNodeSetupStep');
     sandbox.stub(githubWorkflowsCore, 'scaffoldDependencyInstallationStep');
+    sandbox.stub(reusableWorkflow, 'determineAppropriateWorkflow');
   });
 
   teardown(() => sandbox.restore());
@@ -27,21 +30,23 @@ suite('github release workflow scaffolder', () => {
     const projectRoot = any.string();
     const workflowsDirectory = `${projectRoot}/.github/workflows`;
     const dumpedWorkflowYaml = any.simpleObject();
+    const reusableReleaseWorkflowReference = any.string();
+    reusableWorkflow.determineAppropriateWorkflow.withArgs(nodeVersion).returns(reusableReleaseWorkflowReference);
     jsYaml.dump
       .withArgs({
         name: 'Release',
         on: {push: {branches: ['alpha']}},
         jobs: {
           release: {
-            uses: 'form8ion/.github/.github/workflows/release-package.yml@master',
+            uses: reusableReleaseWorkflowReference,
             // eslint-disable-next-line no-template-curly-in-string
             secrets: {NPM_TOKEN: '${{ secrets.NPM_PUBLISH_TOKEN }}'}
           }
         }
       })
       .returns(dumpedWorkflowYaml);
 
-    await scaffoldReleaseWorkflow({projectRoot});
+    await scaffoldReleaseWorkflow({projectRoot, nodeVersion});
 
     assert.calledWith(fs.writeFile, `${workflowsDirectory}/release.yml`, dumpedWorkflowYaml);
   });

src/semantic-release/ci-providers/github-workflows/release-workflow-for-alpha/scaffolder.js

@@ -1,6 +1,8 @@
 import {fileTypes, writeConfigFile} from '@form8ion/core';
 
-export default async function ({projectRoot}) {
+import {determineAppropriateWorkflow} from '../reusable-release-workflow';
+
+export default async function ({projectRoot, nodeVersion}) {
   await writeConfigFile({
     format: fileTypes.YAML,
     path: `${projectRoot}/.github/workflows`,
@@ -10,7 +12,7 @@ export default async function ({projectRoot}) {
       on: {push: {branches: ['alpha']}},
       jobs: {
         release: {
-          uses: 'form8ion/.github/.github/workflows/release-package.yml@master',
+          uses: determineAppropriateWorkflow(nodeVersion),
           // eslint-disable-next-line no-template-curly-in-string
           secrets: {NPM_TOKEN: '${{ secrets.NPM_PUBLISH_TOKEN }}'}
         }

src/semantic-release/ci-providers/github-workflows/reusable-release-workflow-test.js

@@ -15,7 +15,7 @@ suite('reusable release workflow', () => {
   test('that the reusable workflow for semantic-release v19 is defined for a lower node version', async () => {
     assert.equal(
       determineAppropriateWorkflow(any.fromList(['14', '16', '17'])),
-      'form8ion/.github/.github/workflows/release-package-sematnic-release-19.yml@master'
+      'form8ion/.github/.github/workflows/release-package-semantic-release-19.yml@master'
     );
   });
 });

src/semantic-release/ci-providers/github-workflows/reusable-release-workflow.js

@@ -1,5 +1,5 @@
 export function determineAppropriateWorkflow(nodeVersion) {
-  if (18 > nodeVersion) return 'form8ion/.github/.github/workflows/release-package-sematnic-release-19.yml@master';
+  if (18 > nodeVersion) return 'form8ion/.github/.github/workflows/release-package-semantic-release-19.yml@master';
 
   return 'form8ion/.github/.github/workflows/release-package.yml@master';
 }

test/integration/features/lift/older-node.feature

@@ -1,6 +1,5 @@
 Feature: older node version
 
-  @wip
   Scenario: project configured to use older node
     Given the project uses node 16
     And semantic-release is configured