repos: Allow to create draft pull requests #969
Conversation
`Repository.create_pull` and `create_pull_from_issue` now take an optional `draft` argument.
|
Welcome! Thanks for your contribution. We'll be reviewing the code soon(ish) and leaving a pull request review. Our time to review is somewhat... variable. The joys of volunteer open source development :D |
There was a problem hiding this comment.
I think this is a great start. I've left some comments.
The linter is also complaining about line length. You should be able to follow the links from the CI status bots to find where the tests are failing and adjust accordingly.
The other maintainers may have more feedback for you as well.
| ) | ||
| repository.delete() | ||
|
|
||
| assert isinstance(pull_request, github3.pulls.ShortPullRequest) |
There was a problem hiding this comment.
This is a great start here. I think we should be able to validate that the pull request was created in draft mode here as well.
There was a problem hiding this comment.
Sure, but that would require your own pull request #927 to be merged first.
| @@ -322,9 +322,13 @@ def test_create_pull_private_required_data(self): | |||
|
|
|||
| def test_create_pull_private(self): | |||
| """Verify the request for creating a pull request.""" | |||
| data = {"title": "foo", "base": "master", "head": "feature_branch"} | |||
| data = {"title": "foo", "base": "master", "head": "feature_branch", "draft": True} | |||
There was a problem hiding this comment.
This changes the test case to only test the draft code path. For proper coverage there should be two tests, one that tests the draft code path and one that tests the non-draft code path.
|
I'm fairly certain this is present in |
|
@sigmavirus24 can you or perhaps somebody else elaborate on how does this currently work in It looks like a call to repo._create_pull({"title": pr_title, "body": message, "base": "master", "head": head, "draft": True})But that's a private method I assume that users shouldn't access. Not sure if #926 should've been closed too |
Repository.create_pullandcreate_pull_from_issuenow take anoptional
draftargument.This pull request adds support to create draft pull requests. There is already another pull request (#927) to read the draft status when fetching pull requests. These two pull requests are independent and could be merged separately. I just reused the constant
pulls.PULLS_PREVIEW_HEADERSthat is added by #927.Integration tests fail: some cassettes should be updated to include the
draftparameter that we now send. It's not clear to me how to do that properly. I tried to addrecord='all'to calls touse_cassette()in those tests, but I get a403 Must have admin rights to Repository.error on the call to `original_repository.create_fork(organization="testgh3py"). Which I don't find surprising, of course. :) What's the way forward, here?