feat(legacy-release): removed the use of the cycjimmy action when switching to the release trigger

Author: travi

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

@@ -19,7 +19,7 @@ suite('github-workflows lifter for semantic-release', () => {
   const vcsDetails = {name: vcsName, owner: vcsOwner};
   const verificationWorkflowContents = any.string();
   const parsedVerificationWorkflowContents = any.simpleObject();
-  const jobs = any.simpleObject();
+  const jobs = any.objectWithKeys(any.listOf(any.word), {factory: () => ({steps: any.listOf(any.simpleObject)})});
   const legacyReleaseJob = any.simpleObject();
   const updatedVerificationWorkflowContents = any.string();
   const branchTriggers = any.listOf(any.word);
@@ -105,6 +105,62 @@ suite('github-workflows lifter for semantic-release', () => {
     assert.calledWith(fs.writeFile, `${workflowsDirectory}/node-ci.yml`, updatedVerificationWorkflowContents);
   });
 
+  test('that the cycjimmy action is removed', async () => {
+    const jobNameContainingCycjimmyAction = any.word();
+    const otherStepsInJobContainingCycJimmyAction = any.listOf(any.simpleObject);
+    const existingJobs = {
+      ...jobs,
+      [jobNameContainingCycjimmyAction]: {
+        steps: [
+          ...otherStepsInJobContainingCycJimmyAction,
+          {uses: `cycjimmy/semantic-release-action@v${any.integer()}`}
+        ]
+      }
+    };
+    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: existingJobs
+      });
+    jsYaml.dump
+      .withArgs({
+        ...parsedVerificationWorkflowContents,
+        on: {push: {branches: [...branchTriggers, 'beta', ...moreBranchTriggers]}},
+        jobs: {
+          ...jobs,
+          [jobNameContainingCycjimmyAction]: {steps: otherStepsInJobContainingCycJimmyAction},
+          'trigger-release': {
+            'runs-on': 'ubuntu-latest',
+            if: "github.event_name == 'push'",
+            needs: neededJobsToTriggerRelease,
+            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 () => {
     core.fileExists.resolves(true);
     fs.readFile.withArgs(`${workflowsDirectory}/node-ci.yml`, 'utf-8').resolves(verificationWorkflowContents);

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

@@ -5,6 +5,13 @@ import {fileExists, fileTypes, writeConfigFile} from '@form8ion/core';
 import determineTriggerNeedsFrom from './release-trigger-needs';
 import scaffoldReleaseWorkflow from './scaffolder';
 
+function removeCycjimmyActionFrom(otherJobs) {
+  return Object.fromEntries(Object.entries(otherJobs).map(([jobName, job]) => [
+    jobName,
+    {...job, steps: job.steps.filter(step => !step.uses?.includes('cycjimmy/semantic-release-action'))}
+  ]));
+}
+
 export default async function ({projectRoot, vcs: {name: vcsProjectName, owner: vcsOwner}}) {
   const workflowsDirectory = `${projectRoot}/.github/workflows`;
 
@@ -22,7 +29,7 @@ export default async function ({projectRoot, vcs: {name: vcsProjectName, owner:
   const {release, ...otherJobs} = parsedVerificationWorkflowDetails.jobs;
 
   parsedVerificationWorkflowDetails.jobs = {
-    ...otherJobs,
+    ...removeCycjimmyActionFrom(otherJobs),
     'trigger-release': {
       'runs-on': 'ubuntu-latest',
       if: "github.event_name == 'push'",

test/integration/features/lifter.feature

@@ -7,6 +7,14 @@ Feature: Lift
     Then the release workflow is defined
     And the verification workflow triggers the release workflow
 
+  Scenario: cycjimmy action in a GitHub workflow
+    Given semantic-release is configured
+    And the cycjimmy action 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
+    And the cycjimmy action was removed
+
   Scenario: modern semantic-release in GitHub workflows
     Given semantic-release is configured
     And modern releases are configured in a GitHub workflow

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

@@ -45,10 +45,24 @@ When('the project is lifted', async function () {
                 }
               },
               jobs: {
-                verify: {},
-                ...this.multipleNodeVersionsVerified && {'verify-matrix': {}},
-                ...this.nodeCiWithReleaseJob && {release: {}},
-                ...this.nodeCiWithTriggerReleaseJob && {'trigger-release': {}}
+                verify: {steps: []},
+                ...this.multipleNodeVersionsVerified && {'verify-matrix': {steps: []}},
+                ...this.nodeCiWithReleaseJob && {release: {steps: []}},
+                ...this.nodeCiWithCycjimmyAction && {
+                  [any.word()]: {
+                    steps: [{
+                      name: 'semantic-release',
+                      uses: 'cycjimmy/semantic-release-action@v2',
+                      env: {
+                        // eslint-disable-next-line no-template-curly-in-string
+                        GITHUB_TOKEN: '${{ secrets.GH_TOKEN }}',
+                        // eslint-disable-next-line no-template-curly-in-string
+                        NPM_TOKEN: '${{ secrets.NPM_PUBLISH_TOKEN }}'
+                      }
+                    }]
+                  }
+                },
+                ...this.nodeCiWithTriggerReleaseJob && {'trigger-release': {steps: []}}
               }
             })
           },

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

@@ -13,6 +13,12 @@ Given('legacy releases are configured in a GitHub workflow', async function () {
   this.betaBranchTrigger = true;
 });
 
+Given('the cycjimmy action is configured in a GitHub workflow', async function () {
+  this.githubWorkflows = true;
+  this.verificationWorkflow = true;
+  this.nodeCiWithCycjimmyAction = true;
+});
+
 Given('modern releases are configured in a GitHub workflow', async function () {
   this.githubWorkflows = true;
   this.verificationWorkflow = true;
@@ -92,3 +98,12 @@ Then('the release is not triggered until verification completes', async function
   assert.include(triggerReleaseJob.needs, 'verify');
   if (this.multipleNodeVersionsVerified) assert.include(triggerReleaseJob.needs, 'verify-matrix');
 });
+
+Then('the cycjimmy action was removed', async function () {
+  const ciWorkflow = await fs.readFile(
+    `${process.cwd()}/.github/workflows/node-ci.yml`,
+    'utf-8'
+  );
+
+  assert.notInclude(ciWorkflow, 'cycjimmy');
+});