Always fill out PR title after conflict resolution #20
Conversation
Before this change, cherry-picker used to loose the backported commit message and didn't pass anything to the `push_to_remote()` method which resulted in sending an API request to GitHub that had an empty title upon resume. This caused GitHub respond with an error. This code path was only problematic for people having a GitHub token in their env and therefore enjoying the benefits of the PR autocreation. After this change, cherry-picker picks up the commit message correctly and extracts the proper PR title and body out of it.
|
@sivel this should fix your problem ☝️ |
|
Please ignore the nightly job, its failure is unrelated to this change. It happens because pytest turns all warnings into errors. |
|
I've confirmed this fixes my issue. Instead of: The PR is properly created. |
| @@ -277,7 +277,7 @@ def amend_commit_message(self, cherry_pick_branch): | |||
| click.echo(cpe.output) | |||
| return updated_commit_message | |||
|
|
|||
| def push_to_remote(self, base_branch, head_branch, commit_message=""): | |||
| def push_to_remote(self, base_branch, head_branch, commit_message): | |||
There was a problem hiding this comment.
Why is removing the default necessary?
There was a problem hiding this comment.
@webknjaz can we keep the original behavior and let the default commit message?
There was a problem hiding this comment.
I don't remember, it was over a year ago. But I think I wanted to prevent situations when a caller would accidentally leave it empty. Why would one want this behavior to be implicit? If a caller wants an empty title, they should state that explicitly instead of relying on the magical empty value. Besides, it's passed to create_gh_pr() without changes, which already enforces the same.
Before this change, cherry-picker used to loose the backported commit
message and didn't pass anything to the
push_to_remote()method whichresulted in sending an API request to GitHub that had an empty title
upon resume. This caused GitHub respond with an error.
This code path was only problematic for people having a GitHub token in
their env and therefore enjoying the benefits of the PR autocreation.
After this change, cherry-picker picks up the commit message correctly
and extracts the proper PR title and body out of it.