Backport-action v3.1.0

What's Changed

This release adds a new input source_pr_number that allows you to specify the pull request to backport in your workflow. Previously, the action always determined the pull request from the event payload, limiting the action only to backport the pull request associated with the current workflow run. This new input can be helpful in workflows that prefer to be explicit, workflows that run on workflow_dispatch events, and complex workflows that require flexibility. Thanks for this great contribution @chancez!

• Add source_pr_number input by @chancez in #434

New Contributors

• @chancez made their first contribution in #434

Full Changelog: v3.0.2...v3.1.0

Backport-action v3.0.2

Fixed

This release fixes a small bug in the draft_commit_conflicts option for the experimental conflict_resolution feature. When encountering conflicts, the backport pull request is opened in draft mode with the conflicts committed. Instructions are provided to resolve these conflicts locally, but these were incorrect. For more details see #421.

• Checkout draft branch instead of target in suggestion by @korthout in #423

Full Changelog: v3.0.1...v3.0.2

Backport-action v3.0.1

Fixed

This release fixes a small bug in the draft_commit_conflicts option for the experimental conflict_resolution feature. When encountering conflicts, the backport pull request is opened in draft mode with the conflicts committed. Instructions are provided to resolve these conflicts locally, but these were incorrect. For more details see #421.

• Suggest to fetch and checkout draft pr branch directly by @korthout in #422

Full Changelog: v3.0.0...v3.0.1

Backport-action v3.0.0

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.

• Add conflict_resolution input by @vermz99 in #417

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

• build(deps): bump undici from 5.28.3 to 5.28.4 by @dependabot in #418
• build(deps): bump dedent from 1.5.1 to 1.5.3 by @dependabot in #419

New Contributors

• @tasso94 made their first contribution in #405
• @vermz99 made their first contribution in #417

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

Backport-action v2.5.0

What's Changed

• Add configurable branch_name input by @AlexVermette-Eaton in #416

Updated Dependencies

• build(deps): bump undici from 5.27.0 to 5.28.3 by @dependabot in #414

New Contributors

• @AlexVermette-Eaton made their first contribution in #416

Full Changelog: v2.4.1...v2.5.0

Backport-action v2.4.1

What's Changed

• fix: rendering templates due to missing brackets by @jschmid1 in #410

Full Changelog: v2.4.0...v2.4.1

Backport-action v2.4.0

What's Changed

The new ${pull_description} placeholder allows you to copy the original pull request's description to the backported PR. This can be helpful if the body contains links to ticketing systems, related documents etc.

• Add ${pull_description} placeholder by @jschmid1 in #409

Full Changelog: v2.3.0...v2.4.0

Backport-action v2.3.0

What's Changed

This release introduces a new created_pull_numbers output that you can use in successive steps. For example, label the created pull requests or trigger your CI on the created pull requests. Massive thanks to @GuyAv46 for this contribution.

• Add created_pull_numbers output by @GuyAv46 in #404

New Contributors

• @GuyAv46 made their first contribution in #404

Full Changelog: v2.2.0...v2.3.0

Backport-action v2.2.0

What's Changed

This release introduces a new experimental input that you can use to configure experimental features. We encourage everyone to try them out and share feedback.

As a first experimental feature, this release adds detect_merge_method. When enabled, it cherry-picks the resulting commits based on the detected merge method. Give it a try if you're using the Squash and merge or Rebase and merge merge method for your pull requests, and please report any issues you encounter.

To enable merge method detection add the following to your backport workflow:

using: korthout/backport-action@v2
with:
  experimental: >
    {
      "detect_merge_method": true
    }

A special shoutout and heartfelt thanks to @jschmid1 for their outstanding contribution to the detect_merge_method feature!

• Detect squash and rebase merge methods by @jschmid1 in #399

Documentation

• Avoid loop in backport by comment usage example by @jschmid1 in #400
• Align event type in usage example by @chillleader in #401

Updated Dependencies

• build(deps): bump @types/dedent from 0.7.1 to 0.7.2 by @dependabot in #396

New Contributors

• @chillleader made their first contribution in #401

Full Changelog: v2.1.0...v2.2.0

Backport-action v2.1.1

What's Changed

This release fixes a small bug in the suggested steps to cherry-pick locally if backporting fails.

• Skip merge commits in suggestion by @korthout in #397

Updated Dependencies

• build(deps): bump @types/dedent from 0.7.1 to 0.7.2 by @dependabot in #396

Full Changelog: v2.1.0...v2.1.1