feat(verification): removed the alpha branch from the list of triggers 4 the verification workflow

since the release workflow is triggered directly for that branch rather than being gated by
verification passing first

Author: travi

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

@@ -29,7 +29,7 @@ suite('github-workflows lifter for semantic-release', () => {
 
     const commonVerificationWorkflowContents = any.string();
     fs.readFile.withArgs(`${workflowsDirectory}/node-ci.yml`, 'utf-8').resolves(commonVerificationWorkflowContents);
-    jsYaml.load.withArgs(commonVerificationWorkflowContents).returns({jobs: {}});
+    jsYaml.load.withArgs(commonVerificationWorkflowContents).returns({on: {push: {branches: []}}, jobs: {}});
   });
 
   teardown(() => sandbox.restore());
@@ -56,14 +56,21 @@ suite('github-workflows lifter for semantic-release', () => {
     const jobs = any.simpleObject();
     const legacyReleaseJob = any.simpleObject();
     const updatedVerificationWorkflowContents = any.string();
+    const branchTriggers = any.listOf(any.word);
+    const moreBranchTriggers = any.listOf(any.word);
     core.fileExists.resolves(true);
     fs.readFile.withArgs(`${workflowsDirectory}/node-ci.yml`, 'utf-8').resolves(verificationWorkflowContents);
     jsYaml.load
       .withArgs(verificationWorkflowContents)
-      .returns({...parsedVerificationWorkflowContents, jobs: {...jobs, release: legacyReleaseJob}});
+      .returns({
+        ...parsedVerificationWorkflowContents,
+        on: {push: {branches: [...branchTriggers, 'alpha', ...moreBranchTriggers]}},
+        jobs: {...jobs, release: legacyReleaseJob}
+      });
     jsYaml.dump
       .withArgs({
         ...parsedVerificationWorkflowContents,
+        on: {push: {branches: [...branchTriggers, ...moreBranchTriggers]}},
         jobs: {
           ...jobs,
           'trigger-release': {

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

@@ -1,5 +1,5 @@
 import {promises as fs} from 'fs';
-import {load, dump} from 'js-yaml';
+import {dump, load} from 'js-yaml';
 import {fileExists} from '@form8ion/core';
 
 import scaffoldReleaseWorkflow from './scaffolder';
@@ -12,6 +12,11 @@ export default async function ({projectRoot, vcs: {name: vcsProjectName, owner:
   }
 
   const parsedVerificationWorkflowDetails = load(await fs.readFile(pathToVerificationWorkflow, 'utf-8'));
+
+  parsedVerificationWorkflowDetails.on.push.branches = parsedVerificationWorkflowDetails.on.push.branches.filter(
+    branch => 'alpha' !== branch
+  );
+
   const {release, ...otherJobs} = parsedVerificationWorkflowDetails.jobs;
   parsedVerificationWorkflowDetails.jobs = {
     ...otherJobs,

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

@@ -36,6 +36,16 @@ When('the project is lifted', async function () {
         workflows: {
           ...this.verificationWorkflow && {
             'node-ci.yml': dump({
+              on: {
+                push: {
+                  branches: [
+                    'master',
+                    ...this.alphaBranchTrigger ? ['alpha'] : [],
+                    ...this.betaBranchTrigger ? ['beta'] : [],
+                    'dependency-updater/**'
+                  ]
+                }
+              },
               jobs: {
                 ...this.nodeCiWithReleaseJob && {
                   release: {}

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

@@ -9,6 +9,8 @@ Given('legacy releases are configured in a GitHub workflow', async function () {
   this.githubWorkflows = true;
   this.verificationWorkflow = true;
   this.nodeCiWithReleaseJob = true;
+  this.alphaBranchTrigger = true;
+  this.betaBranchTrigger = true;
 });
 
 Given('modern releases are configured in a GitHub workflow', async function () {
@@ -43,6 +45,8 @@ Then('the verification workflow triggers the release workflow', async function (
     'utf-8'
   ));
 
+  assert.deepEqual(verificationWorkflowDefinition.on.push.branches, ['master', 'beta', 'dependency-updater/**']);
+
   const verificationWorkflowJobs = verificationWorkflowDefinition.jobs;
   const triggerReleaseJob = verificationWorkflowJobs['trigger-release'];