Move PR from ready to Draft

[zodman]

Proposed solution

gh pr draft

small update:
thanks @kyanny
https://github.com/kyanny/gh-pr-draft

[vilmibm]

Thanks.

I think we've discussed this but couldn't find an issue for it; @ampinsk do you remember if we wanted this approach or something in a pr edit that would convert a PR back to a draft?

[ampinsk]

Hmm since we went with gh pr ready for the opposite, maybe a command would make sense? it does feel like a small action to get its own whole command though. I'm open to thoughts on it!

[mislav]

See #740 (comment) for context around the original decision to omit a pr draft command

Also see #2015 that proposes a command to update PR metadata, including its draft status, e.g. gh pr update 123 --draft=true

[amiryal]

In the end, both #2015 and #1349 were closed without adding the ability to revert to draft, right?

After further discussion this morning, we decided to reduce initial scope for this
— #740 (comment)

The quote above is from about a year ago, so now may be a good time to expand the scope again.

Here are some UX alternatives to keep you inspired:

• gh pr draft
• gh pr ready --undo
• gh pr ready --not-ready
• gh pr edit --make-draft

(Some were suggested before; feel free to ignore all of them.)

[nmagedman]

@amiryal, I like what you suggested elsewhere. Combining it with the PR metadata proposal @mislav mentioned, here are some more possibilities:

• gh pr edit --ready
• gh pr edit --draft
• gh pr update --ready
• gh pr update --draft

[tzusman]

While we're waiting for a gh pr draft command, maybe @ampinsk or @mislav could help me out with my use case:

1. A PR draft is created by a developer, makes commits
2. PR is deemed ready to go, so they convert to a ready for review PR
3. This kicks off a series of automated tests in GitHub Actions
4. If the tests in the Action fail, I want to revert the PR back to a draft

I'm not seeing a way to do this in the API docs either - but maybe I'm missing something?

[leettaylor]

For those using v2 @kyanny has kindly made an extension which can convert a PR into a draft:

https://github.com/kyanny/gh-pr-draft

[kyanny]

@tzusman GitHub's REST API (v3) doesn't provide the endpoint to convert PR to draft.
But you can use convertPullRequestToDraft mutation provided by GitHub's GraphQL API (v4).
Here is an example of GraphQL mutation query. https://github.com/kyanny/gh-pr-draft/blob/main/gh-pr-draft#L22-L32

[tzusman]

@kyanny thanks, I'm trying to get this implemented, but when I run the following in GitHub Actions:

gh extension install kyanny/gh-pr-draft
gh pr-draft 1

I get an gh: Resource not accessible by integration error. It looks like ${{ secrets.GITHUB_TOKEN }} doesn't have the permission to read the repo even though it's public?

[kyanny]

@tzusman

It looks like ${{ secrets.GITHUB_TOKEN }} doesn't have the permission to read the repo even though it's public?

Yes. According to Automatic token authentication,

The token's permissions are limited to the repository that contains your workflow.

Changing pull request status requires a write permission to the target repository, regardless of its visibility. I guess that the error you've seen indicates the lack of write permission, not read.

You need to use a personal access token. For more details, see Granting additional permissions.