@adobe/helix-deploy 10.2.1 → 10.3.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [10.3.0](https://github.com/adobe/helix-deploy/compare/v10.2.1...v10.3.0) (2024-01-22)
+
+
+### Features
+
+* support environment variable interpolation in config using syntax ${env.VAR_NAME} ([#649](https://github.com/adobe/helix-deploy/issues/649)) ([ae52a1b](https://github.com/adobe/helix-deploy/commit/ae52a1b308a4bf0f986246f25c4937216bfa82f2)), closes [#644](https://github.com/adobe/helix-deploy/issues/644)
+
 ## [10.2.1](https://github.com/adobe/helix-deploy/compare/v10.2.0...v10.2.1) (2024-01-20)
 
 

package/README.md

@@ -4,9 +4,8 @@
 ## Status
 [![GitHub license](https://img.shields.io/github/license/adobe/helix-deploy.svg)](https://github.com/adobe/helix-deploy/blob/main/LICENSE.txt)
 [![GitHub issues](https://img.shields.io/github/issues/adobe/helix-deploy.svg)](https://github.com/adobe/helix-deploy/issues)
-[![CircleCI](https://img.shields.io/circleci/project/github/adobe/helix-deploy.svg)](https://circleci.com/gh/adobe/helix-deploy)
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/adobe/helix-deploy/main.yaml)
 [![codecov](https://img.shields.io/codecov/c/github/adobe/helix-deploy.svg)](https://codecov.io/gh/adobe/helix-deploy)
-[![LGTM Code Quality Grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/adobe/helix-deploy.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/adobe/helix-deploy)
 
 ## Setup
 
@@ -287,6 +286,23 @@ In order to automatically use the version of the `package.json` use:
 > **Note**: the version is internally taken from the `pkgVersion` variable, so it can be overridden with
  the `--pkgVersion` argument, in case it should be deployed differently.
 
+### Environment Variable Interpolation in Arguments
+
+In addition to the `${version}` token described above, arguments will be interpolated using environment variables where the variables exist. For example, given an environment variable named `PROBOT_DOCKER_VERSION` is set to `latest`, this configuration:
+
+```json
+{
+...
+  "wsk": {
+    ...
+    "docker": "adobe/probot-ow-nodejs8:${env.PROBOT_DOCKER_VERSION}"
+  },
+...
+}
+```
+
+Will result in the materialized value of the `docker` argument to be set to `adobe/probot-ow-nodejs8:latest`.
+
 #### Automatically create semantic versioning sequence actions
 
 By using the `--version-link` (`-l`), the bulider can create action sequences _linking_ to the deployed version,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-deploy",
-  "version": "10.2.1",
+  "version": "10.3.0",
   "description": "Library and Commandline Tools to build and deploy OpenWhisk Actions",
   "license": "Apache-2.0",
   "homepage": "https://github.com/adobe/helix-deploy#readme",
@@ -25,6 +25,7 @@
     "test": "c8 mocha -i -g Integration",
     "integration-ci": "c8 mocha -g Integration",
     "semantic-release": "semantic-release",
+    "semantic-release-dry": "semantic-release --dry-run --branches $CI_BRANCH",
     "prepare": "husky install"
   },
   "mocha": {

package/src/cli.js

@@ -38,7 +38,28 @@ export default class CLI {
   constructor() {
     this._yargs = yargs()
       .pkgConf('wsk')
-      .env('HLX');
+      .env('HLX')
+      .middleware((argv) => {
+        // convert process.env to flattened object with flat keys
+        // since ActionBuilder.substitute() expects this format.
+        const envVars = Object.entries(process.env)
+          .reduce((env, [key, value]) => {
+            // eslint-disable-next-line no-param-reassign
+            env[`env.${key}`] = value;
+            return env;
+          }, {});
+
+        const substitute = (value) => (typeof value === 'string' ? ActionBuilder.substitute(value, envVars) : value);
+        Object.entries(argv).forEach(([key, value]) => {
+          if (typeof value === 'string') {
+            // eslint-disable-next-line no-param-reassign
+            argv[key] = substitute(value, envVars);
+          } else if (Array.isArray(value)) {
+            // eslint-disable-next-line no-param-reassign
+            argv[key] = value.map((v) => substitute(v, envVars));
+          }
+        });
+      });
     BaseConfig.yarg(this._yargs);
     PLUGINS.forEach((PluginClass) => PluginClass.Config.yarg(this._yargs));
     this._yargs