feat(experimental-release): create the workflow with a more intent-revealing name

Author: travi

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

@@ -51,6 +51,6 @@ suite('github release workflow scaffolder', () => {
 
     await scaffoldReleaseWorkflow({projectRoot, nodeVersion});
 
-    assert.calledWith(fs.writeFile, `${workflowsDirectory}/release.yml`, dumpedWorkflowYaml);
+    assert.calledWith(fs.writeFile, `${workflowsDirectory}/experimental-release.yml`, dumpedWorkflowYaml);
   });
 });

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

@@ -6,7 +6,7 @@ export default async function ({projectRoot, nodeVersion}) {
   await writeConfigFile({
     format: fileTypes.YAML,
     path: `${projectRoot}/.github/workflows`,
-    name: 'release',
+    name: 'experimental-release',
     config: {
       name: 'Release',
       on: {push: {branches: ['alpha']}},

test/integration/features/lift/lifter.feature

@@ -4,14 +4,14 @@ Feature: Lift
     Given semantic-release is configured
     And legacy releases are configured in a GitHub workflow
     When the project is lifted
-    Then the release workflow calls the reusable workflow for alpha branches
+    Then the experimental release workflow calls the reusable workflow for alpha branches
     And the verification workflow calls the reusable 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 calls the reusable workflow for alpha branches
+    Then the experimental release workflow calls the reusable workflow for alpha branches
     And the verification workflow calls the reusable release workflow
     And the cycjimmy action was removed
 
@@ -20,14 +20,14 @@ Feature: Lift
     And the release workflow is called from the ci workflow
     And a release workflow is defined for alpha
     When the project is lifted
-    Then the release workflow calls the reusable workflow for alpha branches
+    Then the experimental release workflow calls the reusable workflow for alpha branches
 
   Scenario: modern semantic-release in GitHub workflows, but trigger does not wait for verification
     Given semantic-release is configured
     And the release workflow is called from the ci workflow
     And a release workflow is defined for alpha
     When the project is lifted
-    Then the release workflow calls the reusable workflow for alpha branches
+    Then the experimental release workflow calls the reusable workflow for alpha branches
     And the release is not called until verification completes
 
   Scenario: modern semantic-release in GitHub workflows verifying multiple node versions, but trigger does not wait for verification
@@ -36,14 +36,14 @@ Feature: Lift
     And a release workflow is defined for alpha
     And multiple node versions are verified
     When the project is lifted
-    Then the release workflow calls the reusable workflow for alpha branches
+    Then the experimental release workflow calls the reusable workflow for alpha branches
     And the release is not called until verification completes
 
   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 calls the reusable workflow for alpha branches
+    Then the experimental release workflow calls the reusable workflow for alpha branches
     And the verification workflow calls the reusable release workflow
 
   Scenario: no release needed
@@ -64,5 +64,5 @@ Feature: Lift
     And a local release workflow is defined
     And the release workflow is triggered from the ci workflow
     When the project is lifted
-    Then the release workflow calls the reusable workflow for alpha branches
+    Then the experimental release workflow calls the reusable workflow for alpha branches
     And the verification workflow calls the reusable release workflow

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

@@ -5,5 +5,5 @@ Feature: older node version
     And semantic-release is configured
     And no release is configured in a GitHub workflow
     When the project is lifted
-    Then the release workflow calls the reusable workflow for semantic-release v19 for alpha branches
+    Then the experimental release workflow calls the reusable workflow for semantic-release v19 for alpha branches
     And the verification workflow calls the reusable release workflow for semantic-release v19

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

@@ -6,9 +6,14 @@ import {assert} from 'chai';
 import {load} from 'js-yaml';
 
 async function loadReleaseWorkflowDefinition() {
-  assert.isTrue(await fileExists(`${process.cwd()}/.github/workflows/release.yml`), 'Release workflow is missing');
+  assert.isTrue(
+    await fileExists(`${process.cwd()}/.github/workflows/experimental-release.yml`),
+    'Release workflow is missing'
+  );
 
-  const {on: triggers, jobs} = load(await fs.readFile(`${process.cwd()}/.github/workflows/release.yml`, 'utf-8'));
+  const {on: triggers, jobs} = load(
+    await fs.readFile(`${process.cwd()}/.github/workflows/experimental-release.yml`, 'utf-8')
+  );
 
   return {triggers, jobs};
 }
@@ -68,21 +73,27 @@ Given('no GitHub workflows exist', async function () {
   this.githubWorkflows = false;
 });
 
-Then('the release workflow calls the reusable workflow for alpha branches', async function () {
+Then('the experimental release workflow calls the reusable workflow for alpha branches', async function () {
   const {triggers, jobs} = await loadReleaseWorkflowDefinition();
 
   assert.isUndefined(triggers.workflow_dispatch);
   assert.deepEqual(triggers.push.branches, ['alpha']);
   assert.equal(jobs.release.uses, 'form8ion/.github/.github/workflows/release-package.yml@master');
 });
 
-Then('the release workflow calls the reusable workflow for semantic-release v19 for alpha branches', async function () {
-  const {triggers, jobs} = await loadReleaseWorkflowDefinition();
+Then(
+  'the experimental release workflow calls the reusable workflow for semantic-release v19 for alpha branches',
+  async function () {
+    const {triggers, jobs} = await loadReleaseWorkflowDefinition();
 
-  assert.isUndefined(triggers.workflow_dispatch);
-  assert.deepEqual(triggers.push.branches, ['alpha']);
-  assert.equal(jobs.release.uses, 'form8ion/.github/.github/workflows/release-package-semantic-release-19.yml@master');
-});
+    assert.isUndefined(triggers.workflow_dispatch);
+    assert.deepEqual(triggers.push.branches, ['alpha']);
+    assert.equal(
+      jobs.release.uses,
+      'form8ion/.github/.github/workflows/release-package-semantic-release-19.yml@master'
+    );
+  }
+);
 
 Then('the release workflow is not defined', async function () {
   assert.isFalse(await fileExists(`${process.cwd()}/.github/workflows/release.yml`));