feat(release-trigger): determined needed jobs to trigger the release based on existing jobs

Author: travi

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

@@ -6,6 +6,7 @@ import any from '@travi/any';
 import {assert} from 'chai';
 import sinon from 'sinon';
 
+import * as releaseTriggerNeeds from './release-trigger-needs';
 import * as scaffolder from './scaffolder';
 import lift from './lifter';
 
@@ -23,6 +24,7 @@ suite('github-workflows lifter for semantic-release', () => {
   const updatedVerificationWorkflowContents = any.string();
   const branchTriggers = any.listOf(any.word);
   const moreBranchTriggers = any.listOf(any.word);
+  const neededJobsToTriggerRelease = any.listOf(any.word);
 
   setup(() => {
     sandbox = sinon.createSandbox();
@@ -33,6 +35,7 @@ suite('github-workflows lifter for semantic-release', () => {
     sandbox.stub(jsYaml, 'dump');
     sandbox.stub(core, 'fileExists');
     sandbox.stub(scaffolder, 'default');
+    sandbox.stub(releaseTriggerNeeds, 'default');
 
     const commonVerificationWorkflowContents = any.string();
     fs.readFile.withArgs(`${workflowsDirectory}/node-ci.yml`, 'utf-8').resolves(commonVerificationWorkflowContents);
@@ -58,14 +61,16 @@ suite('github-workflows lifter for semantic-release', () => {
   });
 
   test('that the legacy release job is removed', async () => {
+    const existingJobs = {...jobs, release: legacyReleaseJob};
     core.fileExists.resolves(true);
     fs.readFile.withArgs(`${workflowsDirectory}/node-ci.yml`, 'utf-8').resolves(verificationWorkflowContents);
+    releaseTriggerNeeds.default.withArgs(existingJobs).returns(neededJobsToTriggerRelease);
     jsYaml.load
       .withArgs(verificationWorkflowContents)
       .returns({
         ...parsedVerificationWorkflowContents,
         on: {push: {branches: [...branchTriggers, 'alpha', 'beta', ...moreBranchTriggers]}},
-        jobs: {...jobs, release: legacyReleaseJob}
+        jobs: existingJobs
       });
     jsYaml.dump
       .withArgs({
@@ -76,7 +81,7 @@ suite('github-workflows lifter for semantic-release', () => {
           'trigger-release': {
             'runs-on': 'ubuntu-latest',
             if: "github.event_name == 'push'",
-            needs: ['verify'],
+            needs: neededJobsToTriggerRelease,
             steps: [{
               uses: 'octokit/[email protected]',
               with: {
@@ -103,6 +108,7 @@ suite('github-workflows lifter for semantic-release', () => {
   test('that the the release trigger is added when no release is configured yet', async () => {
     core.fileExists.resolves(true);
     fs.readFile.withArgs(`${workflowsDirectory}/node-ci.yml`, 'utf-8').resolves(verificationWorkflowContents);
+    releaseTriggerNeeds.default.withArgs(jobs).returns(neededJobsToTriggerRelease);
     jsYaml.load
       .withArgs(verificationWorkflowContents)
       .returns({
@@ -119,7 +125,7 @@ suite('github-workflows lifter for semantic-release', () => {
           'trigger-release': {
             'runs-on': 'ubuntu-latest',
             if: "github.event_name == 'push'",
-            needs: ['verify'],
+            needs: neededJobsToTriggerRelease,
             steps: [{
               uses: 'octokit/[email protected]',
               with: {

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

@@ -2,6 +2,7 @@ import {promises as fs} from 'fs';
 import {dump, load} from 'js-yaml';
 import {fileExists} from '@form8ion/core';
 
+import determineTriggerNeedsFrom from './release-trigger-needs';
 import scaffoldReleaseWorkflow from './scaffolder';
 
 export default async function ({projectRoot, vcs: {name: vcsProjectName, owner: vcsOwner}}) {
@@ -24,7 +25,7 @@ export default async function ({projectRoot, vcs: {name: vcsProjectName, owner:
     'trigger-release': {
       'runs-on': 'ubuntu-latest',
       if: "github.event_name == 'push'",
-      needs: ['verify'],
+      needs: determineTriggerNeedsFrom(parsedVerificationWorkflowDetails.jobs),
       steps: [{
         uses: 'octokit/[email protected]',
         with: {

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

@@ -0,0 +1,27 @@
+import {assert} from 'chai';
+import any from '@travi/any';
+import determineTriggerNeedsFrom from './release-trigger-needs';
+
+suite('release-trigger needs', () => {
+  test('that no jobs are listed if neither `verify` nor `verify-matrix` are present in `jobs`', async () => {
+    assert.deepEqual(determineTriggerNeedsFrom(any.objectWithKeys(any.listOf(any.word))), []);
+  });
+
+  test('that `verify` is listed if present in `jobs`', async () => {
+    assert.deepEqual(determineTriggerNeedsFrom(any.objectWithKeys([...any.listOf(any.word), 'verify'])), ['verify']);
+  });
+
+  test('that `verify-matrix` is listed if present in `jobs`', async () => {
+    assert.deepEqual(
+      determineTriggerNeedsFrom(any.objectWithKeys([...any.listOf(any.word), 'verify-matrix'])),
+      ['verify-matrix']
+    );
+  });
+
+  test('that `verify` and `verify-matrix` are listed if both are present in `jobs`', async () => {
+    assert.deepEqual(
+      determineTriggerNeedsFrom(any.objectWithKeys(['verify', ...any.listOf(any.word), 'verify-matrix'])),
+      ['verify', 'verify-matrix']
+    );
+  });
+});

src/semantic-release/ci-providers/github-workflows/release-trigger-needs.js

@@ -0,0 +1,8 @@
+export default function (jobs) {
+  const jobNames = Object.keys(jobs);
+
+  return [
+    ...jobNames.includes('verify') ? ['verify'] : [],
+    ...jobNames.includes('verify-matrix') ? ['verify-matrix'] : []
+  ];
+}

test/integration/features/lifter.feature

@@ -20,6 +20,14 @@ Feature: Lift
     Then the release workflow is defined
     And the release is not triggered until verification completes
 
+  Scenario: modern semantic-release in GitHub workflows verifying multiple node versions, but trigger does not wait for verification
+    Given semantic-release is configured
+    And modern releases are configured in a GitHub workflow
+    And multiple node versions are verified
+    When the project is lifted
+    Then the release workflow is defined
+    And the release is not triggered until verification completes
+
   Scenario: no existing release
     Given semantic-release is configured
     And no release is configured in a GitHub workflow

test/integration/features/step_definitions/common-steps.js

@@ -48,12 +48,9 @@ When('the project is lifted', async function () {
               },
               jobs: {
                 verify: {},
-                ...this.nodeCiWithReleaseJob && {
-                  release: {}
-                },
-                ...this.nodeCiWithTriggerReleaseJob && {
-                  'trigger-release': {}
-                }
+                ...this.multipleNodeVersionsVerified && {'verify-matrix': {}},
+                ...this.nodeCiWithReleaseJob && {release: {}},
+                ...this.nodeCiWithTriggerReleaseJob && {'trigger-release': {}}
               }
             })
           },

test/integration/features/step_definitions/github-workflows-steps.js

@@ -29,6 +29,10 @@ Given('no release is configured in a GitHub workflow', async function () {
   this.betaBranchTrigger = false;
 });
 
+Given('multiple node versions are verified', async function () {
+  this.multipleNodeVersionsVerified = true;
+});
+
 Given('no GitHub workflows exist', async function () {
   this.githubWorkflows = false;
 });
@@ -86,4 +90,5 @@ Then('the release is not triggered until verification completes', async function
   const triggerReleaseJob = verificationWorkflowDefinition.jobs['trigger-release'];
 
   assert.include(triggerReleaseJob.needs, 'verify');
+  if (this.multipleNodeVersionsVerified) assert.include(triggerReleaseJob.needs, 'verify-matrix');
 });