feat(release): added the beta branch to the trigger list when the release isnt configured yet

Author: travi

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

@@ -64,13 +64,61 @@ suite('github-workflows lifter for semantic-release', () => {
       .withArgs(verificationWorkflowContents)
       .returns({
         ...parsedVerificationWorkflowContents,
-        on: {push: {branches: [...branchTriggers, 'alpha', ...moreBranchTriggers]}},
+        on: {push: {branches: [...branchTriggers, 'alpha', 'beta', ...moreBranchTriggers]}},
         jobs: {...jobs, release: legacyReleaseJob}
       });
     jsYaml.dump
       .withArgs({
+        ...parsedVerificationWorkflowContents,
+        on: {push: {branches: [...branchTriggers, 'beta', ...moreBranchTriggers]}},
+        jobs: {
+          ...jobs,
+          'trigger-release': {
+            'runs-on': 'ubuntu-latest',
+            if: "github.event_name == 'push'",
+            steps: [{
+              uses: 'octokit/[email protected]',
+              with: {
+                route: 'POST /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches',
+                owner: vcsOwner,
+                repo: vcsName,
+                ref: '${{ github.ref }}',                       // eslint-disable-line no-template-curly-in-string
+                workflow_id: 'release.yml'
+              },
+              env: {
+                GITHUB_TOKEN: '${{ secrets.GH_PAT }}'         // eslint-disable-line no-template-curly-in-string
+              }
+            }]
+          }
+        }
+      })
+      .returns(updatedVerificationWorkflowContents);
+
+    await lift({projectRoot, vcs: vcsDetails});
+
+    assert.calledWith(fs.writeFile, `${workflowsDirectory}/node-ci.yml`, updatedVerificationWorkflowContents);
+  });
+
+  test('that the the release trigger is added when no release is configured yet', async () => {
+    const verificationWorkflowContents = any.string();
+    const parsedVerificationWorkflowContents = any.simpleObject();
+    const jobs = 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,
         on: {push: {branches: [...branchTriggers, ...moreBranchTriggers]}},
+        jobs
+      });
+    jsYaml.dump
+      .withArgs({
+        ...parsedVerificationWorkflowContents,
+        on: {push: {branches: [...branchTriggers, ...moreBranchTriggers, 'beta']}},
         jobs: {
           ...jobs,
           'trigger-release': {

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

@@ -13,9 +13,10 @@ 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
-  );
+  parsedVerificationWorkflowDetails.on.push.branches = [
+    ...parsedVerificationWorkflowDetails.on.push.branches.filter(branch => 'alpha' !== branch),
+    ...!parsedVerificationWorkflowDetails.on.push.branches.includes('beta') ? ['beta'] : []
+  ];
 
   const {release, ...otherJobs} = parsedVerificationWorkflowDetails.jobs;
   parsedVerificationWorkflowDetails.jobs = {

test/integration/features/lifter.feature

@@ -14,6 +14,13 @@ Feature: Lift
     Then the release workflow is defined
 
   Scenario: no existing release
+    Given semantic-release is configured
+    And no release is configured in a GitHub workflow
+    When the project is lifted
+    Then the release workflow is defined
+    And the verification workflow triggers the release workflow
+
+  Scenario: no release needed
     Given semantic-release is not configured
     And no release is configured in a GitHub workflow
     When the project is lifted

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

@@ -25,6 +25,8 @@ Given('no release is configured in a GitHub workflow', async function () {
   this.verificationWorkflow = true;
   this.nodeCiWithReleaseJob = false;
   this.nodeCiWithTriggerReleaseJob = false;
+  this.alphaBranchTrigger = false;
+  this.betaBranchTrigger = false;
 });
 
 Given('no GitHub workflows exist', async function () {
@@ -44,8 +46,11 @@ Then('the verification workflow triggers the release workflow', async function (
     `${process.cwd()}/.github/workflows/node-ci.yml`,
     'utf-8'
   ));
+  const branchTriggers = verificationWorkflowDefinition.on.push.branches;
 
-  assert.deepEqual(verificationWorkflowDefinition.on.push.branches, ['master', 'beta', 'dependency-updater/**']);
+  assert.include(branchTriggers, 'master');
+  assert.include(branchTriggers, 'beta');
+  assert.include(branchTriggers, 'dependency-updater/**');
 
   const verificationWorkflowJobs = verificationWorkflowDefinition.jobs;
   const triggerReleaseJob = verificationWorkflowJobs['trigger-release'];