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:

• discussion issue
• pull request containing changes
• deprecation docs

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

⚠️ It should be noted that this release comes with potentially breaking changes as the 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

• Skip unnecessary CI triggers by @sinsoku in #143

Full Changelog: v5.2.1...v5.2.2

v5.2.1

v5.2.1

This release fixes a bug identified by @dmccaffery. If a repository had no CI checks defined and and PR was approved, then no conditions would be met and branch-deploy would not continue.

Additional Changes:

• Updating Actions workflows
• Updating all node packages

What's Changed

• Upgrade yaml validation by @GrantBirki in #140
• Update Documentation by @GrantBirki in #141
• CI Status Check Fixes by @GrantBirki in #142

Full Changelog: v5.2.0...v5.2.1

v5.2.0

v5.2.0

What's Changed

• More docs updates by @GrantBirki in #136
• no trigger detected log by @GrantBirki in #137
• General Repo Updates by @GrantBirki in #138
• Action Config Validation by @GrantBirki in #139

Full Changelog: v5.1.1...v5.2.0

v5.1.1

v5.1.1

This release fixes a bug where the log_url in deployment statuses was not being properly set.

This release also updates documentation, update Actions workflows in our CI, and adds new docs examples using Astro.

What's Changed

• Fix log_url in deployment status by @sinsoku in #132
• Add non-sticky lock removal to the example by @sinsoku in #133
• Examples Docs Updates by @GrantBirki in #134
• Update all Actions Workflows by @GrantBirki in #135

Full Changelog: v5.1.0...v5.1.1

v5.1.0

v5.1.0

Introducing environment_urls with deployments! 🚀

This pull request adds a new Action's input option called environment_urls. The input option is a mapping of "environments" -> "environment urls" that can be deployed.

Configuration

Explanation for the formatting of this new input option

This input option is a mapping of environment names to URLs and the environment names must match the environment_targets input option. This option is a comma separated list with pipes (|) separating the environment from the URL.

Note: disabled is a special keyword to disable an environment url if you enable this option but not all environments have a url.

Format: "<environment1>|<url1>,<environment2>|<url2>,etc"

Example: "production|https://myapp.com,development|https://dev.myapp.com,staging|disabled"

This option is especially useful when your deployment targets are services with a URL (website, API, etc)

By enabling this option, you will get a "clickable" link on success (non-noop) deployment messages on pull requests. You will also be able to click the "View deployment" button in your repository's deployments page and be taken to the URL of the environment you deployed to.

If you wish to disable the "clickable" link on the successful deloyment message, you can set the environment_url_in_comment input to "false".

Example Usage

If running this Action deploys a website called example.com and that deployment is run with .deploy to production, then you can setup the following mapping with this new input option like so:

- name: branch-deploy
  id: branch-deploy
  uses: github/[email protected]
  with:
    trigger: ".deploy"
    environment: "production"
    environment_targets: "production,development,staging"
    environment_urls: "production|https://example.com,development|https://dev.example.com,staging|stg.example.com"
    environment_url_in_comment: "true"

By setting up this Action, you can get "View deployment" buttons on your environment page that allow you view the URL associated with your deployment

Additionally, if a matching environment url is found for an environment and the deployment is not a noop deploy, the URL with a clickable link will be appended to the bottom of a successful deployment message:

---

What's Changed

• Test Framework Improvements 🧪 by @GrantBirki in #126
• environment_url in deployments by @GrantBirki in #128
• Environment URL Improvements by @GrantBirki in #129
• --reason (lock/unlock) bug fixes by @GrantBirki in #130
• ensure --reason is removed from unlock commands by @GrantBirki in #131

Full Changelog: v5.0.0...v5.1.0