feat: pass custom environment variables to shell command

Author: scrocquesel

README.md

@@ -36,6 +36,12 @@ The plugin can be configured in the [**semantic-release** configuration file](ht
       "@semantic-release/exec",
       {
         "verifyConditionsCmd": "./verify.sh",
+        "prepareCmd": {
+          "cmd": "./prepare.sh ${nextRelease.version} ${nextRelease.gitTag}",
+          "env": {
+            "NEXT_RELEASE_NOTES": "${nextRelease.notes}"
+          }
+        },
         "publishCmd": "./publish.sh ${nextRelease.version} ${branch.name} ${commits.length} ${Date.now()}"
       }
     ]
@@ -68,7 +74,14 @@ With this example:
 | `shell`               | The shell to use to run the command. See [execa#shell](https://github.com/sindresorhus/execa#shell).                                                                                                                                                                                                                                     |
 | `execCwd`             | The path to use as current working directory when executing the shell commands. This path is relative to the path from which **semantic-release** is running. For example if **semantic-release** runs from `/my-project` and `execCwd` is set to `buildScripts` then the shell command will be executed from `/my-project/buildScripts` |
 
-Each shell command is generated with [Lodash template](https://lodash.com/docs#template). All the [`context` object keys](https://github.com/semantic-release/semantic-release/blob/master/docs/developer-guide/plugin.md#context) passed to semantic-release plugins are available as template options.
+Each shell command can be a string or an object with the following properties:
+
+| Property | Description                                           |
+| -------- | ------------------------------------------------------|
+| `cmd`    | The shell command to execute.                         |
+| `env`    | An object to pass as additional environment variables |
+
+Each shell command and environment variable value are generated with [Lodash template](https://lodash.com/docs#template). All the [`context` object keys](https://github.com/semantic-release/semantic-release/blob/master/docs/developer-guide/plugin.md#context) passed to semantic-release plugins are available as template options.
 
 ## verifyConditionsCmd
 

lib/exec.js

@@ -1,25 +1,46 @@
 import { resolve } from "path";
-import { template } from "lodash-es";
+import { template, isNil, isPlainObject, isString } from "lodash-es";
 import { execa } from "execa";
 
 export default async function exec(
   cmdProp,
   { shell, execCwd, ...config },
   { cwd, env, stdout, stderr, logger, ...context },
 ) {
+
   const cmd = config[cmdProp] ? cmdProp : "cmd";
-  const script = template(config[cmd])({ config, ...context });
+
+  const cmdParsed = parseCommand(config[cmd])
+  const script = template(cmdParsed.cmd)({ config, ...context });
+
+  const envInterpolated = {
+    ...env,
+    ...Object.entries(cmdParsed.env).reduce((acc, [key, value]) => {
+      acc[key] = template(value)({ config, ...context });
+      return acc;
+    }, {})
+  }
 
   logger.log("Call script %s", script);
 
+
   const result = execa(script, {
     shell: shell || true,
     cwd: execCwd ? resolve(cwd, execCwd) : cwd,
-    env,
+    env: envInterpolated,
   });
 
   result.stdout.pipe(stdout, { end: false });
   result.stderr.pipe(stderr, { end: false });
 
   return (await result).stdout.trim();
 }
+
+function parseCommand(cmd) {
+  if (isString(cmd)) {
+    return { cmd, env: {} };
+  }
+  else if (isPlainObject(cmd) && !isNil(cmd.cmd)) {
+    return { cmd: cmd.cmd, env: cmd.env || {} };
+  }
+}

lib/verify-config.js

@@ -1,12 +1,15 @@
-import { isNil, isString } from "lodash-es";
+import { isNil, isPlainObject, isString } from "lodash-es";
 import AggregateError from "aggregate-error";
 import getError from "./get-error.js";
 
 const isNonEmptyString = (value) => isString(value) && value.trim();
 const isOptional = (validator) => (value) => isNil(value) || validator(value);
+const isCmdWithEnv = (value) => isPlainObject(value) && isNonEmptyString(value.cmd) && (isOptional(isObjectOfStrings)(value.env));
+const isStringOrCmdWithEnv = (value) => isNonEmptyString(value) || isCmdWithEnv(value);
+const isObjectOfStrings = (value) => isPlainObject(value) && Object.values(value).every(element => isString(element));
 
 const VALIDATORS = {
-  cmd: isNonEmptyString,
+  cmd: isStringOrCmdWithEnv,
   shell: isOptional((shell) => shell === true || isNonEmptyString(shell)),
   execCwd: isOptional(isNonEmptyString),
 };
@@ -30,12 +33,12 @@ export default function verifyConfig(
       VALIDATORS[option](value)
         ? errors
         : [
-            ...errors,
-            getError(`EINVALID${option.toUpperCase()}`, {
-              [option]: value,
-              cmdProp,
-            }),
-          ],
+          ...errors,
+          getError(`EINVALID${option.toUpperCase()}`, {
+            [option]: value,
+            cmdProp,
+          }),
+        ],
     [],
   );
 

test/exec.test.js

@@ -51,6 +51,28 @@ test("Generate command with template", async (t) => {
   t.is(result, "confValue 1.0.0");
 });
 
+test("Generate command with env variables", async (t) => {
+  const pluginConfig = {
+    publishCmd: {
+      cmd: `./test/fixtures/echo-args.sh \${config.conf} \${lastRelease.version}`,
+      env: {
+        NEXT_RELEASE_NOTES: "${nextRelease.notes}",
+      },
+    },
+    conf: "confValue",
+  };
+  const context = {
+    stdout: t.context.stdout,
+    stderr: t.context.stderr,
+    lastRelease: { version: "1.0.0" },
+    nextRelease: { notes: "notes &\"'" },
+    logger: t.context.logger
+  };
+
+  const result = await exec("publishCmd", pluginConfig, context);
+  t.is(result, "confValue 1.0.0 notes &\"'");
+});
+
 test('Execute the script with the specified "shell"', async (t) => {
   const context = {
     stdout: t.context.stdout,

test/fixtures/echo-args.sh

@@ -1,2 +1,2 @@
 #!/bin/bash 
-echo "$@"
+echo "$@" "$NEXT_RELEASE_NOTES"