feat: add prepare hook

Author: pvdlg

README.md

@@ -49,6 +49,16 @@ Execute a shell command to generate the release note.
 | `stdout`         | Only the release note must be written to `stdout`.                                                                  |
 | `stderr`         | Can be used for logging.                                                                                            |
 
+## prepare
+
+Execute a shell command to prepare the release.
+
+| Command property | Description                                                                                                         |
+|------------------|---------------------------------------------------------------------------------------------------------------------|
+| `exit code`      | Any non `0` code is considered as an unexpected error and will stop the `semantic-release` execution with an error. |
+| `stdout`         | Can be used for logging.                                                                                            |
+| `stderr`         | Can be used for logging.                                                                                            |
+
 ## publish
 
 Execute a shell command to publish the release.

index.js

@@ -46,6 +46,10 @@ async function generateNotes(pluginConfig, params) {
   return execScript(pluginConfig, params);
 }
 
+async function prepare(pluginConfig, params) {
+  await execScript(pluginConfig, params);
+}
+
 async function publish(pluginConfig, params) {
   const stdout = await execScript(pluginConfig, params);
   return stdout.trim() ? parseJson(stdout) : undefined;
@@ -59,4 +63,4 @@ async function fail(pluginConfig, params) {
   await execScript(pluginConfig, params);
 }
 
-module.exports = {verifyConditions, analyzeCommits, verifyRelease, generateNotes, publish, success, fail};
+module.exports = {verifyConditions, analyzeCommits, verifyRelease, generateNotes, prepare, publish, success, fail};

test/fail.test.js

@@ -12,10 +12,8 @@ test.beforeEach(t => {
   t.context.logger = {log: t.context.log, error: t.context.error};
 });
 
-test.serial('Return the value fail script wrote to stdout', async t => {
-  const pluginConfig = {
-    cmd: './test/fixtures/echo-args.sh',
-  };
+test.serial('Execute script in fail step', async t => {
+  const pluginConfig = {cmd: './test/fixtures/echo-args.sh'};
   const params = {logger: t.context.logger};
 
   await t.notThrows(fail(pluginConfig, params));

test/prepare.test.js

@@ -0,0 +1,27 @@
+import test from 'ava';
+import {stub} from 'sinon';
+import {prepare} from '..';
+
+stub(process.stdout, 'write');
+stub(process.stderr, 'write');
+
+test.beforeEach(t => {
+  // Mock logger
+  t.context.log = stub();
+  t.context.error = stub();
+  t.context.logger = {log: t.context.log, error: t.context.error};
+});
+
+test.serial('Execute script in prepare step', async t => {
+  const pluginConfig = {cmd: './test/fixtures/echo-args.sh'};
+  const params = {logger: t.context.logger};
+
+  await t.notThrows(prepare(pluginConfig, params));
+});
+
+test.serial('Throw "Error" if the prepare script does not returns 0', async t => {
+  const pluginConfig = {cmd: 'exit 1'};
+  const params = {logger: t.context.logger};
+
+  await t.throws(prepare(pluginConfig, params), Error);
+});

test/success.test.js

@@ -12,10 +12,8 @@ test.beforeEach(t => {
   t.context.logger = {log: t.context.log, error: t.context.error};
 });
 
-test.serial('Return the value success script wrote to stdout', async t => {
-  const pluginConfig = {
-    cmd: './test/fixtures/echo-args.sh',
-  };
+test.serial('Execute script in success step', async t => {
+  const pluginConfig = {cmd: './test/fixtures/echo-args.sh'};
   const params = {logger: t.context.logger};
 
   await t.notThrows(success(pluginConfig, params));