feat(lift): added the release workflow when not already defined

if the ci provider is github actions

Author: travi

package-lock.json

@@ -83,7 +83,9 @@
     "sinon": "12.0.1"
   },
   "dependencies": {
+    "@form8ion/core": "^1.4.2",
     "@form8ion/javascript-core": "^4.0.0",
-    "deepmerge": "^4.2.2"
+    "deepmerge": "^4.2.2",
+    "js-yaml": "^4.1.0"
   }
 }

package.json

@@ -0,0 +1,3 @@
+export {default as scaffold} from './scaffolder';
+export {default as test} from './tester';
+export {default as lift} from './lifter';

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

@@ -0,0 +1,38 @@
+import * as core from '@form8ion/core';
+
+import any from '@travi/any';
+import {assert} from 'chai';
+import sinon from 'sinon';
+
+import * as scaffolder from './scaffolder';
+import lift from './lifter';
+
+suite('github-workflows lifter for semantic-release', () => {
+  let sandbox;
+  const projectRoot = any.string();
+
+  setup(() => {
+    sandbox = sinon.createSandbox();
+
+    sandbox.stub(core, 'fileExists');
+    sandbox.stub(scaffolder, 'default');
+  });
+
+  teardown(() => sandbox.restore());
+
+  test('that the release workflow is added if it doesnt already exist', async () => {
+    core.fileExists.resolves(false);
+
+    await lift({projectRoot});
+
+    assert.calledWith(scaffolder.default, {projectRoot});
+  });
+
+  test('that the release workflow is not added if it already exists', async () => {
+    core.fileExists.withArgs(`${projectRoot}/.github/workflows/release.yml`).resolves(true);
+
+    await lift({projectRoot});
+
+    assert.notCalled(scaffolder.default);
+  });
+});

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

@@ -0,0 +1,9 @@
+import {fileExists} from '@form8ion/core';
+
+import scaffoldReleaseWorkflow from './scaffolder';
+
+export default async function ({projectRoot}) {
+  if (!await fileExists(`${projectRoot}/.github/workflows/release.yml`)) {
+    await scaffoldReleaseWorkflow({projectRoot});
+  }
+}

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

@@ -0,0 +1,59 @@
+import {promises as fs} from 'fs';
+import jsYaml from 'js-yaml';
+
+import {assert} from 'chai';
+import sinon from 'sinon';
+import any from '@travi/any';
+
+import scaffoldReleaseWorkflow from './scaffolder';
+
+suite('github release workflow scaffolder', () => {
+  let sandbox;
+
+  setup(() => {
+    sandbox = sinon.createSandbox();
+
+    sandbox.stub(fs, 'writeFile');
+    sandbox.stub(jsYaml, 'dump');
+  });
+
+  teardown(() => sandbox.restore());
+
+  test('that release workflow is defined', async () => {
+    const projectRoot = any.string();
+    const workflowsDirectory = `${projectRoot}/.github/workflows`;
+    const dumpedWorkflowYaml = any.simpleObject();
+    jsYaml.dump
+      .withArgs({
+        on: {push: {branches: ['alpha']}, workflow_dispatch: {}},
+        env: {FORCE_COLOR: 1, NPM_CONFIG_COLOR: 'always'},
+        jobs: {
+          release: {
+            'runs-on': 'ubuntu-latest',
+            steps: [
+              {uses: 'actions/checkout@v2'},
+              {
+                name: 'Setup node',
+                uses: 'actions/setup-node@v2',
+                with: {'node-version-file': '.nvmrc', cache: 'npm'}
+              },
+              {run: 'npm clean-install'},
+              {
+                name: 'semantic-release',
+                run: 'npx semantic-release',
+                env: {
+                  GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}',      // eslint-disable-line no-template-curly-in-string
+                  NPM_TOKEN: '${{ secrets.NPM_PUBLISH_TOKEN }}'     // eslint-disable-line no-template-curly-in-string
+                }
+              }
+            ]
+          }
+        }
+      })
+      .returns(dumpedWorkflowYaml);
+
+    await scaffoldReleaseWorkflow({projectRoot});
+
+    assert.calledWith(fs.writeFile, `${workflowsDirectory}/release.yml`, dumpedWorkflowYaml);
+  });
+});

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

@@ -0,0 +1,34 @@
+import {promises as fs} from 'fs';
+import {dump} from 'js-yaml';
+
+export default async function ({projectRoot}) {
+  await fs.writeFile(
+    `${projectRoot}/.github/workflows/release.yml`,
+    dump({
+      on: {push: {branches: ['alpha']}, workflow_dispatch: {}},
+      env: {FORCE_COLOR: 1, NPM_CONFIG_COLOR: 'always'},
+      jobs: {
+        release: {
+          'runs-on': 'ubuntu-latest',
+          steps: [
+            {uses: 'actions/checkout@v2'},
+            {
+              name: 'Setup node',
+              uses: 'actions/setup-node@v2',
+              with: {'node-version-file': '.nvmrc', cache: 'npm'}
+            },
+            {run: 'npm clean-install'},
+            {
+              name: 'semantic-release',
+              run: 'npx semantic-release',
+              env: {
+                GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}',        // eslint-disable-line no-template-curly-in-string
+                NPM_TOKEN: '${{ secrets.NPM_PUBLISH_TOKEN }}'       // eslint-disable-line no-template-curly-in-string
+              }
+            }
+          ]
+        }
+      }
+    })
+  );
+}

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

@@ -0,0 +1,31 @@
+import * as core from '@form8ion/core';
+
+import any from '@travi/any';
+import sinon from 'sinon';
+import {assert} from 'chai';
+import projectUsesGithubWorkflows from './tester';
+
+suite('GitHub workflows predicate', () => {
+  const projectRoot = any.string();
+  let sandbox;
+
+  setup(() => {
+    sandbox = sinon.createSandbox();
+
+    sandbox.stub(core, 'directoryExists');
+  });
+
+  teardown(() => sandbox.restore());
+
+  test('that `true` is returned when the project uses GitHub workflows', async () => {
+    core.directoryExists.withArgs(`${projectRoot}/.github/workflows`).resolves(true);
+
+    assert.isTrue(await projectUsesGithubWorkflows({projectRoot}));
+  });
+
+  test('that `false` is returned when the project uses GitHub workflows', async () => {
+    core.directoryExists.resolves(false);
+
+    assert.isFalse(await projectUsesGithubWorkflows({projectRoot}));
+  });
+});

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

@@ -0,0 +1,5 @@
+import {directoryExists} from '@form8ion/core';
+
+export default function ({projectRoot}) {
+  return directoryExists(`${projectRoot}/.github/workflows`);
+}

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

@@ -0,0 +1 @@
+export {lift, test, scaffold} from './github-workflows';