⚠️ Breaking Change ⚠️
TL;DR: If you are using the
production_environment
input, add a letters
to the end of it to make it plural 😉
This breaking change only effects users who have production_environment
defined as one of their input options. Simply add an "s" to the end of the input option and treat it as a comma separated list of strings. Here is an example:
...
uses: github/branch-deploy@vX.X.X
with:
trigger: ".deploy"
environment: "production"
stable_branch: "main"
- production_environment: "production"
+ production_environments: "production"
Release Details
This release enables support for multiple production environments. Before this change, the production_environment
input value only accepted a single environment. This is not idea for projects that might do something like this:
.deploy production
- Deploys code to the production environment.deploy production-eu
- Deploys code to a specialized European production environment (think, GDPR)
Since the production_environment
input option only takes one value, we cannot set the production-eu
environment as "production" via our API call to GitHub (happens inside of this Action for you). However, production-eu
is absolutely a production environment, the name even says so!
To solve this, the production_environment
input option will be removed and replaced with its plural counterpart -> production_environments
(note the trailing s).
Now you can have lots of production environments, like this:
- name: branch-deploy
id: branch-deploy
uses: github/branch-deploy@vX.X.X
with:
trigger: ".deploy"
noop_trigger: ".noop"
reaction: "eyes"
environment: "production"
stable_branch: "main"
production_environments: "production,production-eu,production-ap" # <-- a comma separated list of environments
What's Changed
- Support Multiple Production Environments by @GrantBirki in #209
Thanks to @mnaser for the feedback around this improvement 🙇
Full Changelog: v7.5.2...v8.0.0