Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: make backport.py more flexible for complex pull requests #7260

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from
Open

feat: make backport.py more flexible for complex pull requests #7260

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4b4bff7
feat: "backport.py --skip X" omits commit X from cherry-picking
cfm Oct 17, 2024
b29b884
fix: call "gh api --paginate" to fetch all commits in a pull request
cfm Oct 17, 2024
8a4462d
refactor: use list comprehension with inline conditional
cfm Oct 18, 2024
ae00ff7
feat: list skipped commits in pull request
cfm Oct 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions utils/backport.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,26 +16,36 @@
parser.add_argument("pr", type=int, help="the # of the PR to backport")
parser.add_argument("version", help="the release version to target with the backport")
parser.add_argument("remote", default="origin", help="the git remote to use (defaults to origin)")
parser.add_argument("--skip", default=[], action="append", help="don't cherry-pick these commits")
args = parser.parse_args()

title = json.loads(
subprocess.check_output(["gh", "pr", "view", str(args.pr), "--json", "title"], text=True)
)["title"]
commits = json.loads(
subprocess.check_output(
["gh", "api", f"repos/{{owner}}/{{repo}}/pulls/{args.pr}/commits"], text=True
["gh", "api", "--paginate", f"repos/{{owner}}/{{repo}}/pulls/{args.pr}/commits"], text=True
)
)
print(f'Backporting {len(commits)} commits from "{title}"')

# NB. It's tempting to do something like `set(commit_hashes) -= set(args.skip)`
# here, but we must preserve the order of commits, and it's not worth pulling
# in an ordered-set implementation just for this.
commit_hashes = [commit["sha"] for commit in commits if commit["sha"] not in args.skip]

print(f'Backporting {len(commit_hashes)}/{len(commits)} commits from "{title}"')
branch = f"backport-{args.pr}"
base = f"release/{args.version}"
remote = args.remote
subprocess.check_call(["git", "fetch", remote])
subprocess.check_call(["git", "checkout", "-b", branch, f"{remote}/{base}"])
subprocess.check_call(["git", "cherry-pick", "-x"] + [commit["sha"] for commit in commits])
subprocess.check_call(["git", "cherry-pick", "-x"] + commit_hashes)
if input("OK to push and create PR? [y/N]").lower() != "y":
sys.exit()
subprocess.check_call(["git", "push", "-u", remote, branch])
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the message body below, let's mention the skipped commits? E.g. Only contains changes from #{args.pr}, except {commits}.?

Copy link
Member Author

@cfm cfm Oct 18, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea. Added in 234d5bf, but do let me know if you see a nicer way to build up the conditional skip_message without fancier templating.


skip_list = ", ".join(args.skip)
skip_message = f", excluding {skip_list}" if len(args.skip) > 0 else ""
body = f"""\
## Status

Expand All @@ -49,7 +59,7 @@

* [ ] CI is passing
* [ ] base is `{base}`
* [ ] Only contains changes from #{args.pr}.
* [ ] Only contains changes from #{args.pr} #{skip_message}
"""
print(body)

Expand Down
Loading