Improve cherry-pick warning message for better clarity#18756
Merged
harupy merged 2 commits intomlflow:masterfrom Nov 10, 2025
Merged
Improve cherry-pick warning message for better clarity#18756harupy merged 2 commits intomlflow:masterfrom
harupy merged 2 commits intomlflow:masterfrom
Conversation
- Changed title to H1 for better visibility - Restructured content with clearer language and formatting - Added specific examples of workflows/scripts that are affected - Made bullet points more explicit by adding 'It' as subject - Replaced technical jargon with clearer terms 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> Signed-off-by: harupy <17039389+harupy@users.noreply.github.com>
harupy
commented
Nov 10, 2025
| owner: context.repo.owner, | ||
| repo: context.repo.repo, | ||
| body: '### 🚨 Important Reminder:\nAre you cherry-picking commits to a release branch? If so, please ensure you use the `Rebase and merge` option when merging this pull request. Do not use the `Squash and merge` option, as it makes reverting individual commits impossible. If the `Rebase and merge` option is disabled (it usually is), follow [Configuring commit rebasing for pull requests](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-rebasing-for-pull-requests) to temporarily enable it, and disable it once the PR is merged.' | ||
| body: `# ⚠️ Important: Cherry-Pick Merge Instructions |
Member
Author
There was a problem hiding this comment.
I believe this message is still valuable when Squash and merge is somehow enabled.
harupy
commented
Nov 10, 2025
| - It disrupts the [\`update-release-labels.yml\`](.github/workflows/update-release-labels.yml) workflow | ||
| - It disrupts the [\`update_changelog.py\`](dev/update_changelog.py) script | ||
|
|
||
| If "Rebase and merge" is disabled, follow [Configuring commit rebasing for pull requests](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-rebasing-for-pull-requests) to enable it.` |
Member
Author
There was a problem hiding this comment.
I've enabled Rebase and merge but note that anyone with admin role can turn it on/off.
harupy
commented
Nov 10, 2025
|
|
||
| **If you are cherry-picking commits to a release branch, "Rebase and merge" must be used when merging this PR, NOT "Squash and merge".** | ||
|
|
||
| ### Why "Squash and merge" causes problems: |
Member
Author
There was a problem hiding this comment.
We can complicate the instruction by adding "Use Squash and merge if ..." but I didn't want to do that. A few Ci fixes should be acceptable and you don't push 10 CI fix commits on a cherry-pick PR.
- Replace 'disrupts' with 'causes incorrect results in' for clarity - Use nested list to show affected workflow and scripts - Add check_patch_prs.py to the list of affected scripts - Remove redundant 'workflow/script' labels 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> Signed-off-by: harupy <17039389+harupy@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🛠 DevTools 🛠
Install mlflow from this PR
For Databricks, use the following command:
Related Issues/PRs
N/A
What changes are proposed in this pull request?
This PR improves the warning message shown on cherry-pick PRs to release branches. The new message is clearer, better structured, and provides more context about why "Squash and merge" should be avoided.
Key improvements:
How is this PR tested?
The workflow will trigger on PRs targeting release branches (branch-X.Y pattern) and post the improved warning message.
Does this PR require documentation update?
Release Notes
Is this a user-facing change?
How should the PR be classified in the release notes? Choose one:
rn/none- No description will be included. The PR will be mentioned only by the PR number in the "Small Bugfixes and Documentation Updates" sectionShould this PR be included in the next patch release?
🤖 Generated with Claude Code