v9.1.1

What's Changed

This release contains one bug fix, some documentation updates, and dependency updates

• Bump the github-actions group with 3 updates by @dependabot in #245
• Add read access to statuses to required permissions by @greysteil in #248
• Bug: Running unlock when no-lock exists returns an error by @GrantBirki in #250
• Bump the npm-dependencies group with 6 updates by @dependabot in #251

New Contributors

• @greysteil made their first contribution in #248

Full Changelog: v9.1.0...v9.1.1

v9.1.0

Overview

This release introduces a new input option called checks (thanks to @Ugzuzg! 🎉). The checks feature has been a long sought after feature of this Action to give teams better control over what CI checks have to be passing in order for a deployment to proceed. This feature was originally requested way back in 2022 and it has finally landed!

The detailed documentation around the checks input can be found here.

TL;DR: A new input option called checks allows for teams to choose whether they want all CI checks to pass before a deployment can proceed or if only the explicitly required CI checks need to be passing.

What's Changed

• Add checks mode input by @Ugzuzg in #241
• Bump the npm_and_yarn group across 1 directories with 1 update by @dependabot in #242
• node package updates by @GrantBirki in #243
• Checks input docs by @GrantBirki in #244

New Contributors

• @Ugzuzg made their first contribution in #241 🎉

Full Changelog: v9...v9.1.0

v9.0.0

What's Changed

---

⚠️ potentially breaking change! ⚠️

The vast majority of teams should be able to upgrade to v9.0.0 without any issues

It should be noted that this change is only "breaking" in the sense that unexpected behavior may take place for teams using more unique git flows for development. If you want to maintain the current state of this Action on v9.0.0 and beyond, all you need to do is to simply set outdated_mode: "pr_base" in the Action configuration. Most teams using this Action will not notice any issues upgrading to v9.x.x.

---

This release introduces a new input option (outdated_mode) for fine grain control over deployments when a branch is deemed "out-of-date" 🎉. These changes were introduced in #237 and the aforementioned pull request contains a lot of information around these changes. You can also view the detailed documentation around this new input option to learn more and how you and your team can use it. Enjoy!

• Bump the github-actions group with 2 updates by @dependabot in #238
• Bump the npm-dependencies group with 5 updates by @dependabot in #239
• Update Base Branch Improvements by @GrantBirki in #237
• update all node deps by @GrantBirki in #240

Full Changelog: v8...v9.0.0

---

Huge thank you to @jessew-albert for helping out with the features in this release! 🙇

v8.2.1

This patch release contains internal dependency updates

What's Changed

• Bump the github-actions group with 4 updates by @dependabot in #233
• Bump the npm-dependencies group with 4 updates by @dependabot in #232
• node package updates by @GrantBirki in #234

Full Changelog: v8...v8.2.1

v8.2.0

What's Changed

• Added: Support for GitHub EMU handles @GrantBirki in #227
• Updated: Internal Node Packages by @GrantBirki in #228

Full Changelog: v8...v8.2.0

v8.1.2

What's Changed

This release updates internal node dependencies that this Action uses

• add new tag release workflow for major tags by @GrantBirki in #222
• add dependabot config by @GrantBirki in #223
• Bump the github-actions group with 3 updates by @dependabot in #224
• Bump the npm-dependencies group with 7 updates by @dependabot in #225

Full Changelog: v8...v8.1.2

v8.1.1

This patch release simply upgrades internal node packages and dependencies

What's Changed

• Update Examples Documentation by @GrantBirki in #220
• Node Updates by @GrantBirki in #221

Full Changelog: v8.1.0...v8.1.1

v8.1.0

This release introduces two new input options!

• allow_sha_deployments - Enable deployments to exact SHA1 or SHA256 hashes that represent a point-in-time in your commit history
• disable_naked_commands - Prevent naked deploy commands and enforce environment usage in your commands

These new input options can be enabled like so:

- uses: github/[email protected]
  id: branch-deploy
  with:
    allow_sha_deployments: "true" # <-- allow deployments to SHA hashes
    disable_naked_commands: "true" # <-- prevent the use of .deploy without a specific <environment>

Both of these new input options are disabled by default but can be enabled if you choose to do so. Please ensure you read the documentation about each option before toggling them on as they can drastically change the behavior of this Action

Documentation:

• allow_sha_deployments
• disable_naked_commands

What's Changed

• sha deployments by @GrantBirki in #212
• Prevent Naked Deploys by @GrantBirki in #214
• Update Action Workflows by @GrantBirki in #215
• Dependencies by @GrantBirki in #216
• Output msg fixes by @GrantBirki in #217

Thanks to @tiagonbotelho for the SHA deployment suggestion and @mnaser for UX suggestions with disabling "naked commands"

Full Changelog: v8.0.0...v8.1.0

v8.0.0

⚠️ Breaking Change ⚠️

TL;DR: If you are using the production_environment input, add a letter s 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/[email protected]
  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/[email protected]
  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

v7.5.2

This release makes internal changes to upgrade the Action to node20 and it also updates all internal node dependencies with npm update

What's Changed

• Upgrade to node20 by @GrantBirki in #206
• update all node dependencies by @GrantBirki in #207

Full Changelog: v7.5.1...v7.5.2