Skip to content

Backport-action v3.0.0

Compare
Choose a tag to compare
@korthout korthout released this 26 May 11:50
· 32 commits to main since this release

Changed

  • [Breaking] Use merge method to cherry-pick by default by @korthout in #420

This release changes the default behavior of the action to determine which commits are cherry-picked. While this behavior change doesn't necessarily require changes to your workflow, it warrants a major version bump.

Previously, the action cherry-picked the commits from the pull request. Specifically, those reachable from the pull request's head and not reachable from the pull request's base.

From now on, the action cherry-picks the commits based on the method used to merge the pull request by default.

  • For "Squash and merge", the action cherry-picks the squashed commit.
  • For "Rebase and merge", the action cherry-picks the rebased commits.
  • For "Merged as a merge commit", the action cherry-picks the commits from the pull request.

If you previously used the experimental detect_merge_method input, we suggest you remove it from your workflow. This experimental input has been deprecated and replaced by the cherry_picking input.

If you want to return to the previous behavior, you can set the cherry_picking input to pull_request_head.

This behavior was previously available via the experimental detect_merge_method input, introduced in #399. Special thanks go out to @jschmid1 for contributing this feature.

Added

This release also adds two new experimental features. Special shoutouts to @tasso94 and @vermz99 for contributing these!

  • Allow backporting to a downstream repository by @tasso94 in #405

With the experimental downstream_repo and downstream_owner inputs, you can backport to a repository other than where the workflow runs. For example, when you use a fork to maintain the previously released versions. You can also see this as backporting to a remote repository, but we felt it was better described as backporting to a downstream repository. The default behavior remains that the action always backports to the repository in which the workflow runs.

With the experimental conflict_resolution input, you can now change how the action will handle conflicts during cherry-picking. Set it to draft_commit_conflicts to create a draft pull request with the first conflict encountered committed to reduce some of the manual efforts in backporting. The default behavior stays like before and can be configured explicitly as fail. In that case, the backport fails when the cherry-pick encounters a conflict.

Updated Dependencies

New Contributors

Full Changelog: v2.5.0...v3.0.0