v9.3.0

What's Changed

🏷️ Labels! 🏷️

This release introduces a new feature known as "post deployment labels". These labels can be configured via a set of four new Action inputs:

Input	Required?	Default	Description
successful_deploy_labels	false	""	A comma separated list of labels to add to the pull request when a deployment is successful. Example: "deployed,success"
successful_noop_labels	false	""	A comma separated list of labels to add to the pull request when a noop deployment is successful. Example: "noop,success"
failed_deploy_labels	false	""	A comma separated list of labels to add to the pull request when a deployment fails. Example: "failed,deploy-failed"
failed_noop_labels	false	""	A comma separated list of labels to add to the pull request when a noop deployment fails. Example: "failed,noop-failed"

If you use all (or even some) of these new input options, label will be automatically applied (or removed) from your pull request depending on the resulting state of the deployment.

Here is an example scenario:

1. Someone runs .noop to start a Terraform plan
2. The .noop completes successfully so the branch-deploy Action adds the ready-for-review label on your pull request
3. Your team reviews the PR and approves it
4. Now you are clear to .deploy 🚀

New Outputs!

This Action now exports additional outputs that can be utilized by subsequent workflow steps:

• review_decision
• is_outdated
• merge_state_status
• commit_status
• approved_reviews_count

View the action.yml file in this repo or the main README to learn more about these new outputs

A New Custom Deployment Message Variable!

This release also introduces a new deployment message variable that can be rendered into custom deployment messages:

• approved_reviews_count

This variable will display the number of approved reviews on the pull request at the time of deployment.

---

• Post Deploy Feature Improvements by @GrantBirki in #272
• node package updates by @GrantBirki in #273

---

Full Changelog: v9...v9.3.0

v9.2.0

What's Changed

This release contains a new minor change related to the size of comments that can be posted on PRs. If the comment body (from a deployment) is too large, it will be truncated and collapsed inside of an expandable details block in markdown. This prevents the Action from failing if a comment is over the fixed size limit for GitHub issue comments.

This release also contains internal node package updates for npm packages that this Action relies on.

• Bump the github-actions group with 2 updates by @dependabot in #259
• handle messages that are bigger than issue body limit by @nodeselector in #266
• Bump GrantBirki/json-yaml-validate from 2.7.1 to 3.0.0 in the github-actions group by @dependabot in #264
• update all internal node packages by @GrantBirki in #268
• Truncate improvements by @GrantBirki in #270

New Contributors

• @nodeselector made their first contribution in #266

Full Changelog: v9...v9.2.0

v9.1.3

What's Changed

A small bug fix

• Fixes unchecked sticky by @reggi in #257

New Contributors

• @reggi made their first contribution in #257

Full Changelog: v9.1.2...v9.1.3

v9.1.2

What's Changed

This release updates internal node dependencies that are required for this Action to be packaged and developed

• Bump the npm-dependencies group with 1 update by @dependabot in #252
• Node and Actions updates by @GrantBirki in #254

Full Changelog: v9.1.1...v9.1.2

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