feat: support new draft status for PRs #45
Conversation
Github added a new "draft" mode for PRs, they also added new properties on events to be able to check if a PR is in draft mode or not. This PR takes the draft mode into account in order to show the status as pending (because draft) instead of failing (because it was detected as not-mergeable, as if there was a conflict with master)
IgorMinar
left a comment
IgorMinar
left a comment
There was a problem hiding this comment.
Hi @ocombe without any docs or tests this change is hard to review. Could you please provide these upfront prior to asking for a review?
The code looks like something that could run correctly at runtime, but the typescript implementation doesn't look right to me - I think you are working around the type system here.
I also don't understand what you mean by "(because it was detected as not-mergeable, as if there was a conflict with master)" and what role does merge_state play here.
Can you please clarify these? thanks
| export interface CachedPullRequest extends Github.PullRequestsGetResponse { | ||
| pendingReviews?: number; | ||
| mergeable_state?: string; | ||
| draft?: boolean; |
There was a problem hiding this comment.
can you add docs for these states? where do these states come from and why are they part of CachedPullRequest rather than PullRequestsGetResponse?
Am I missing something or are you just satisfying the compiler so that it doesn't complain about new properties due to outdated Github.PullRequestsGetResponse typings?
There was a problem hiding this comment.
Yes, it's new properties that weren't available at the time.
Probot has been updated and those typings as well, we need to update the libraries to have those.
|
We talked about it in previous PRs but it's really hard to add tests for the bot right now, I'll need to see if we can improve that with the recent versions of probot. The code does indeed work correctly at runtime, I tested it on my test repo and it's been in production for over a month already :) |
4 participants
Github added a new "draft" mode for PRs, they also added new properties on events to be able to check if a PR is in draft mode or not.
This PR takes the draft mode into account in order to show the status as pending (because draft) instead of failing (because it was detected as not-mergeable, as if there was a conflict with master)