@govuk-pay/cli 0.0.22 → 0.0.23

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@govuk-pay/cli",
-  "version": "0.0.22",
+  "version": "0.0.23",
   "description": "GOV.UK Pay Command Line Interface",
   "bin": {
     "pay": "bin/cli.js",

package/readme.md

@@ -40,6 +40,21 @@ use the command `legacy`, for example:
 
 Please add an issue any time you need to fall back on legacy behaviour so we can improve the typescript implementation.
 
+### Config files
+
+Config files needed by the pay cli will go in `$HOME/.pay-cli"
+
+#### Pay Local Config Files
+
+You can override environment variables set in the the .env files in [the pay local services local config directory](https://github.com/alphagov/pay-cli/tree/main/resources/legacy-ruby-cli/lib/pay_cli/commands/local/files/services` for
+specific containers by placing files in `$HOME/.pay-cli/local/environment-overrides/<app_name>.env`.
+
+For example to override an environment variable for connector which was set in [connector.env](https://github.com/alphagov/pay-cli/blob/main/resources/legacy-ruby-cli/lib/pay_cli/commands/local/files/services/connector.env)
+you could create the file `$HOME/.pay-cli/local/environment-overrides/connector.env`
+
+Note: This will only override variables set in the .env files, it will not override any variables which get declared in an `environment` configuration option in the generated docker-compose files. These are generated from the
+[docker-compose.erb](https://github.com/alphagov/pay-cli/blob/main/resources/legacy-ruby-cli/lib/pay_cli/commands/local/files/docker-compose.erb#L5) template.
+
 ## Vulnerability Disclosure
 
 GOV.UK Pay aims to stay secure for everyone. If you are a security researcher and have discovered a security vulnerability in this code, we appreciate your help in disclosing it to us in a responsible manner. Please refer to our [vulnerability disclosure policy](https://www.gov.uk/help/report-vulnerability) and our [security.txt](https://vdp.cabinetoffice.gov.uk/.well-known/security.txt) file for details.

package/resources/legacy-ruby-cli/lib/pay_cli/commands/local/files/docker-compose.erb

@@ -32,6 +32,9 @@ services:
       env_file:
         - services/java_app.env
         - services/<%= app[:name] %>.env
+        <% if File.exist?(File.join(Dir.home, ".pay-cli", "local", "environment-overrides", "#{app[:name]}.env")) %>
+        - <%= File.join(Dir.home, ".pay-cli", "local", "environment-overrides", "#{app[:name]}.env") %>
+        <% end %>
       environment:
         - BIND_HOST=0.0.0.0
         - RUN_MIGRATION=true
@@ -116,6 +119,9 @@ services:
       env_file:
         - services/java_app.env
         - services/<%= app[:name] %>.env
+        <% if File.exist?(File.join(Dir.home, ".pay-cli", "local", "environment-overrides", "#{app[:name]}.env")) %>
+        - <%= File.join(Dir.home, ".pay-cli", "local", "environment-overrides", "#{app[:name]}.env") %>
+        <% end %>
       environment:
         - BIND_HOST=0.0.0.0
         - RUN_MIGRATION=true
@@ -199,7 +205,11 @@ services:
         <%= app[:name] %>_db:
           condition: service_healthy
       <% end %>
-      env_file: services/<%= app[:name] %>.env
+      env_file:
+        - services/<%= app[:name] %>.env
+        <% if File.exist?(File.join(Dir.home, ".pay-cli", "local", "environment-overrides", "#{app[:name]}.env")) %>
+        - <%= File.join(Dir.home, ".pay-cli", "local", "environment-overrides", "#{app[:name]}.env") %>
+        <% end %>
       environment:
         - BIND_HOST=0.0.0.0
         - SECURE_COOKIE_OFF=true
@@ -254,7 +264,11 @@ services:
         <%= app[:name] %>_db:
           condition: service_healthy
       <% end %>
-      env_file: services/<%= app[:name] %>.env
+      env_file:
+        - services/<%= app[:name] %>.env
+        <% if File.exist?(File.join(Dir.home, ".pay-cli", "local", "environment-overrides", "#{app[:name]}.env")) %>
+        - <%= File.join(Dir.home, ".pay-cli", "local", "environment-overrides", "#{app[:name]}.env") %>
+        <% end %>
       <% if @mount_local_node_apps %>
       volumes:
         - "$WORKSPACE/pay-<%= app[:name] %>:/app"