Skip to content

Releases: github/branch-deploy

v8.2.1

03 Jan 20:49
153de21
Compare
Choose a tag to compare

This patch release contains internal dependency updates

What's Changed

Full Changelog: v8...v8.2.1

v8.2.0

18 Dec 19:31
8973281
Compare
Choose a tag to compare

What's Changed

Full Changelog: v8...v8.2.0

v8.1.2

01 Dec 19:42
67cd82f
Compare
Choose a tag to compare

What's Changed

This release updates internal node dependencies that this Action uses

Full Changelog: v8...v8.1.2

v8.1.1

25 Oct 16:52
43004c8
Compare
Choose a tag to compare

This patch release simply upgrades internal node packages and dependencies

What's Changed

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

v8.1.0

16 Oct 17:02
eb93668
Compare
Choose a tag to compare

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:

What's Changed

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

15 Sep 20:53
82c238c
Compare
Choose a tag to compare

⚠️ 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

Thanks to @mnaser for the feedback around this improvement 🙇

Full Changelog: v7.5.2...v8.0.0

v7.5.2

07 Sep 20:35
bfd31c1
Compare
Choose a tag to compare

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

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

v7.5.1

07 Sep 20:04
346835a
Compare
Choose a tag to compare

v7.5.1

This release adds new documentation and squashes a long living bug related to how merge commits are checked when using the "Merge Commit Strategy" workflow. @chrisgavin lent a hand to squash this tricky bug and now the "Merge Commit Strategy" workflow will continue to run as expected, even if you make merge commits into your branch, update your branch, or resolve merge conflicts 🎉.

What's Changed

New Contributors

Full Changelog: v7.5.0...v7.5.1

v7.5.0

01 Sep 22:43
ae2b8fa
Compare
Choose a tag to compare

v7.5.0

@hubot Style Deploy Locking 🔒

This release introduces Hubot Style Deploy Locking (aka sticky deployment locks). Currently, when you run .deploy it creates a lock during the deployment and then releases the lock when the deployment completes. By using the new input option that this release introduces, you can change the deployment locking behavior so that the lock persists even after the deployment finishes.

New Input Options:

  • sticky_locks - By default, this value is set to "false".
  • sticky_locks_for_noop - By default, this value is set to "false". You should probably leave it disabled unless you have a significant reason to lock an environment due to a .noop style deployment

Example:

- name: branch-deploy
  id: branch-deploy
  uses: github/[email protected]
    with:
      sticky_locks: "true" # <--- enables sticky deployment lock / hubot style deployment locks
      sticky_locks_for_noop: "true" # <--- enables sticky deployment lock / hubot style deployment locks for noop deployments
      # ... other configuration

This option, combined with the "Unlock on Merge" workflow strategy is highly suggested for mission critical projects using this Action to deploy their code to production.

You can learn more about this new method of deployment locking by reading the new documentation 📚.

This release will be internally tested at GitHub before being set to the latest release

What's Changed v7.4.0

Full Changelog: v7.3.1...v7.4.0

What's Changed v7.5.0

Full Changelog: v7.4.0...v7.5.0

v7.3.1

29 Aug 21:20
4eda8f9
Compare
Choose a tag to compare

v7.3.1

This release fixes a bug where a deployment gets denied if reviews are disabled and no CI checks have been defined

Thanks to @redoz for finding this bug!

What's Changed


Full Changelog: v7.3.0...v7.3.1