Skip to content

Update korthout/backport-action action to v5 - #249

Merged
YongDo-Hyun merged 1 commit into
developfrom
renovate/korthout-backport-action-5.x
Nov 17, 2026
Merged

YongDo-Hyun merged 1 commit into
developfrom
renovate/korthout-backport-action-5.x

Conversation

@renovate

@renovate renovate Bot commented Nov 11, 2026

Copy link
Copy Markdown
Contributor

This PR contains the following updates:

Package Type Update Change
korthout/backport-action action major v4.7.1 → v5.0.0

Release Notes

korthout/backport-action

v5.0.0: Backport-action v5.0.0

Compare Source

🎂 Six years of backport-action

Six years ago today, on November 11, 2020, the first commit of backport-action landed. What started as a small script to save us from cherry-picking by hand has grown into an action trusted by projects of all sizes. Among the public repositories using it, 137 have over 100 stars, 67 have over 1,000, 18 have over 10,000, and 4 have over 100,000. We've had 48 releases, with contributions from 24 people. And we've collected 125 stars ourselves.

Thank you to everyone who contributed code, reported an issue, shared an idea, or simply trusted this action with your backports. A new major release is a fitting way to mark the occasion. Here's to the next six years!

Breaking changes

v5 is all about improving placeholders: the ${...} values the action fills into the pull_title, pull_description and branch_name templates. The default templates use them too. Most workflows won't notice a difference. If you've customized pull_title, pull_description or branch_name, check the notes below.

All placeholders
Every occurrence of a placeholder is replaced

A placeholder that occurs more than once in a template is now replaced everywhere. A template like ${pull_number} ... ${pull_number} now results in 123 ... 123, as you'd expect. Previously it resulted in 123 ... ${pull_number}.

The same fix also changes two less common cases:

  • Placeholders inside inserted text are no longer expanded. If the original pull request's description contains ${target_branch}, it now appears literally instead of being replaced.
  • $ in the original pull request's title or description is kept as written. Previously sequences like $$, $&, $` and $' were rewritten, so echo $$ > app.pid became echo $ > app.pid. If you worked around this, for example by doubling $$ into $$$$, remove the workaround.

Fixes #​435 and #​694.

Specific placeholders
${issue_refs} lists the references a description refers to, once and as written, ignoring comments, code, and link text

${issue_refs} now reads the original pull request's description as Markdown and lists the issues and pull requests it refers to: each one once, as written there. It now ignores references in code, comments, and link text. In v4 it matched patterns in the raw text, so it missed many references and picked up some that weren't references at all.

Take this description:

Fixes #​752, fixes #​753. Follow-up of https://github.com/korthout/backport-action/pull/749
and Korthout/Backport-Action#752, see also [the checkout bug](https://redirect.github.com/actions/checkout/issues/1).

```yaml

### not a reference: #​706
```

<!-- Closes #&#8203;755 -->

With pull_description: "Relates to ${issue_refs}", v4 gives Relates to #&#8203;706 #&#8203;755. v5 gives Relates to Korthout/Backport-Action#752 #&#8203;753 korthout/backport-action#749 actions/checkout#1.

  • Now listed: references next to punctuation, as in (#&#8203;123) or Fixes #&#8203;123.; references separated by a single space; GH-123; pull request URLs, also when followed by punctuation, a query or a fragment; and links to an issue or pull request, like [the bug](https://redirect.github.com/owner/repo/issues/123).
  • No longer listed: references in comments (<!-- ... -->), such as the instructions in a pull request template; in code (fenced, indented or inline); in HTML attributes or inside <code>, <pre> and <a href>; and in a link's text.
  • Each issue once, as written: a template could expand to #&#8203;1234 #&#8203;1234 #&#8203;1234. Now each issue is listed once, in the order it first appears and in its first spelling. An issue written both as #123 and in full is listed in full, so it keeps referring to the original repository.

A URL is still listed as owner/repo#123, and ${pull_description} still contains the full description, comments included. No configuration needed.

Thanks to @​remcowesterhoud, who started this work by making ${issue_refs} ignore comments and repeated references. Fixes #​706, #​752, #​753, #​755 and #​756.

What's Changed

The README now describes v5: its examples use korthout/backport-action@v5, and the notice that v5 wasn't released yet is gone.

Updated dependencies

Maintenance changes

Full Changelog: korthout/backport-action@v4.7.2...v5.0.0

v4.7.2: Backport-action v4.7.2

Compare Source

What's Changed

Thanks to two contributions by @​bahimehdi, this release fixes two bugs. Neither needs any configuration.

With comment_style: legacy, the action posts an explanatory comment when the original pull request isn't merged, or when it contains merge commits with merge_commits: fail. Previously, if GitHub rejected that comment, the job could crash. Now the action logs the failure and doesn't fail the job, as it already did for the summary comment.

With merge_commits: skip, a pull request that contains only merge commits was reported as a failed backport for every target branch, with instructions to cherry-pick no commits. With experimental.conflict_resolution: draft_commit_conflicts, the action instead pushed an unchanged backport branch for each target branch. Now the action explains once, on the original pull request, that there is nothing to backport and why, and doesn't touch any target branch. It sets was_successful to true, as it does when every target branch already contains the changes. With comment_style: summary, that looks like this:

Backport-action found nothing left to backport from this pull request in workflow run 123.

This pull request contains only merge commits, and merge_commits: skip excludes them.

The summary comment also no longer says "backported this pull request" when every target branch was skipped, for example because its backport pull request already exists. It now says "found nothing left to backport from this pull request".

The README now explains how to run CI on your backport pull requests right away. With the default GITHUB_TOKEN, CI doesn't run on backport pull requests, or its runs wait for approval. The new Run CI on backport pull requests section shows how to give the action a GitHub App token instead, and pass it to both actions/checkout and the action. The README also explains what public repositories need to do before GitHub blocks pull_request_target on December 2, 2026: allow the event for the backport workflow in an Actions policy (and issue_comment too, if you trigger backports with a comment).

New Contributors

Maintenance changes

Full Changelog: korthout/backport-action@v4.7.1...v4.7.2


Configuration

📅 Schedule: (UTC)

  • 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 was generated by Mend Renovate. View the repository job log.

@renovate
renovate Bot requested a review from YongDo-Hyun as a code owner November 11, 2026 09:48
@YongDo-Hyun
YongDo-Hyun merged commit 557dfdd into develop Nov 17, 2026
21 of 23 checks passed
@YongDo-Hyun
YongDo-Hyun deleted the renovate/korthout-backport-action-5.x branch November 17, 2026 20:41
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