Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update github/branch-deploy action to v9 #1177

Merged
merged 1 commit into from
Feb 16, 2024

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Feb 5, 2024

Mend Renovate

This PR contains the following updates:

Package Type Update Change
github/branch-deploy action major v7.5.2 -> v9.0.0

Release Notes

github/branch-deploy (github/branch-deploy)

v9.0.0

Compare Source

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 https://github.com/github/branch-deploy/pull/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!

Full Changelog: github/branch-deploy@v8...v9.0.0


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

v8.2.1

Compare Source

This patch release contains internal dependency updates

What's Changed

Full Changelog: github/branch-deploy@v8...v8.2.1

v8.2.0

Compare Source

What's Changed

Full Changelog: github/branch-deploy@v8...v8.2.0

v8.1.2

Compare Source

What's Changed

This release updates internal node dependencies that this Action uses

Full Changelog: github/branch-deploy@v8...v8.1.2

v8.1.1

Compare Source

This patch release simply upgrades internal node packages and dependencies

What's Changed

Full Changelog: github/branch-deploy@v8.1.0...v8.1.1

v8.1.0

Compare Source

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: github/branch-deploy@v8.0.0...v8.1.0

v8.0.0

Compare Source

⚠️ 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: github/branch-deploy@v7.5.2...v8.0.0


Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR has been generated by Mend Renovate. View repository job log here.

@renovate renovate bot force-pushed the renovate/github-branch-deploy-9.x branch from 46afd0e to 700bb79 Compare February 16, 2024 22:45
@renovate renovate bot force-pushed the renovate/github-branch-deploy-9.x branch from 700bb79 to 4e01e1e Compare February 16, 2024 22:46
@oscrx oscrx merged commit 55a7818 into main Feb 16, 2024
7 of 8 checks passed
Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

@renovate renovate bot deleted the renovate/github-branch-deploy-9.x branch February 16, 2024 22:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant