Releases: github/branch-deploy
v7.3.0
v7.3.0
This new release brings life to this Action's log output though the magic of emojis 🔮 and colors 🌈 !
Example 📸 :
This release also does the following (summarized):
- Moves from
core.getInput()
tocore.getBooleanInput()
internally (where applicable) - Updates all internal node packages with
npm update
- Further updates internal node packages via updating package pins in
package.json
- Slight code performance improvements
- Slight test cleanup
- Adds new GitHub Action's output variables:
issue_number
- The issue (PR) number which the Action was triggered on
- Adding the
octokit
retry plugin to additional functions
What's Changed
The pull requests that are baked into this release
- General Improvements by @GrantBirki in #188
- Additional Octokit Retries & Additional Colors 🌈 by @GrantBirki in #189
- Additional msg formatting by @GrantBirki in #190
Full Changelog: v7.2.2...v7.3.0
v7.2.2
v7.2.2
Minor and rare bug fix with
.lock
commands
This release fixes a rare edge case with the .lock
functionality of this Action. If users --reason <message
contained any part of the lockInfoFlag
flags, then it would think the request is for lock details, and not to claim the actual lock. This was a wacky bug but it is now resolved by just adding a single leading whitespace character to our lockInfoFlag
variable.
This release also adds enhanced debug logging for lock related functions that are internal to this Action
What's Changed
- Lock bug by @GrantBirki in #187
Full Changelog: v7.2.1...v7.2.2
v7.2.1
v7.2.1
This release fixes a minor edge case where the "post deploy" step could fail if the request for lockData
returned null
. Thanks to @malancas for finding this bug!
What's Changed
- Post Deploy Fixes by @GrantBirki in #183
Full Changelog: v7.2.0...v7.2.1
v7.2.0
v7.2.0
This release introduces retries for all Octokit requests. This issue was raised in #180 which pointed out that potential latency was causing the Action to fail when it was trying to add a file to a branch that didn't quite exist yet. This release adds significant improvements for resiliency when making requests to the GitHub API through Octokit retries.
Users do not need to do anything when upgrading to this release and retries will be handled for you out of the box.
Enjoy! 🚀
What's Changed
- Octokit Retries by @GrantBirki in #181
Full Changelog: v7.1.0...v7.2.0
v7.1.0
v7.1.0
This release introduces a new input parameter for this Action:
deploy_message_path
- The path to a markdown file which is used as a template for custom deployment messages
You can read more about this change under the dedicated documentation for custom deployment messages.
This release will give users of this Action even more flexibility to customize what their projects deployment messages look like! All this can now be done in our familiar friend, markdown and it also comes with nunjucks template rendering support 🚀.
What's Changed
- File Based Post Deploy Messages by @GrantBirki in #174
- Code cleanup by @GrantBirki in #175
- node package updates by @GrantBirki in #176
- Documentation Updates by @GrantBirki in #177
- add example screenshot by @GrantBirki in #178
Full Changelog: v7.0.0...v7.1.0
v7.0.0
v7.0.0
⚠️ Breaking Changes ⚠️
This new major release changes the way that "noop" style commands work. Starting with this release, the .deploy noop
command will no longer work and it will be immediately replaced with .noop
instead. The core reasoning for this, is so that .noop
can become its own standalone command and no longer be a subset of the .deploy
command. This will lead to less mistakes, user error, and higher flexibility when customizing this Action for future projects.
What do I need to do?
For most users, you don't need to do anything at all. Simply use .noop
(the default) instead of .deploy noop
. In fact, if you upgrade to v7.0.0
(this release) and run .deploy noop
, you will be presented with a comment containing details about the command to use instead and a link to the deprecation docs
You can always customize the noop_trigger
input option to be something else besides .noop
(you could do .plan
if you're doing Terraform things for example) but the "noop" trigger will never again be a subset of the primary deploy command.
Why was this change made?
Here are some suggested readings to learn more about why this change was made if you are curious to learn more:
What's Changed
- noop prefix enhancements by @GrantBirki in #169
isDeprecated
Function Fixes by @GrantBirki in #171- node package updates by @GrantBirki in #172
Full Changelog: v6.1.0...v7.0.0
v6.1.0
v6.1.0
This release introduces a new input option from @szymonpk's suggestion #163.
This input option is called draft_permitted_targets
and allows for users to designate certain environments that can be deployed to via a pull request in a "draft" state. By default, no environments can be deployed to from draft PRs but this option may be configured if you or your organization has a special use case where you would like to deploy a draft pull request.
More details about this change can be found here -> #166
What's Changed
- Draft Permitted Targets by @GrantBirki in #166
- Node Dependencies by @GrantBirki in #167
Full Changelog: v6.0.1...v6.1.0
v6.0.1
v6.0.1
Updates internal node dependencies
What's Changed
- update unlock-on-merge docs by @GrantBirki in #162
- node package updates by @GrantBirki in #164
Full Changelog: v6.0.0...v6.0.1
v6.0.0
v6.0.0
This is a new major release which implements two new large features:
- Parameter Support via #146
- Auto-Release Deployment Locks via #150
- "Sticky" lock fixes via #158
- Added
maintain
role to deployment permissions as it was missing via #157 - Added a new
permissions
input option via #161 - Added a new
actor
output via #161
prefix_only
input has been removed. For reading about why this feature has been removed, please read the pull request description where this change was made here
What's Changed
- Parameter Support by @GrantBirki in #146
- Package Updates by @GrantBirki in #149
- Auto Release Deployment Locks by @GrantBirki in #150
- Unlock on merge fixes by @GrantBirki in #151
- update docs by @GrantBirki in #152
- update 'Unlock On Merge Mode' docs by @GrantBirki in #153
- Added 'maintain' role to valid-permissions.js by @juboe-kion in #157
- Sticky Lock Fixes - Logging Improvements by @GrantBirki in #158
- v6.0.0 Improvements by @GrantBirki in #161
New Contributors
- @juboe-kion made their first contribution in #157
Full Changelog: v5.2.2...v6.0.0
v5.2.2
v5.2.2
This pull request updates the commit message of locks to prevent unnecessary CI triggers
What's Changed
Full Changelog: v5.2.1...v5.2.2