Add support for draft PRs (#577)

47degrees · Nov 23, 2020 · 128c2e9 · 128c2e9
1 parent 354065b
commit 128c2e9
Show file tree

Hide file tree

Showing 6 changed files with 29 additions and 13 deletions.
diff --git a/github4s/src/main/scala/github4s/domain/PullRequest.scala b/github4s/src/main/scala/github4s/domain/PullRequest.scala
@@ -32,7 +32,8 @@ final case class PullRequest(
     base: Option[PullRequestBase] = None,
     head: Option[PullRequestBase] = None,
     user: Option[User] = None,
-    assignee: Option[User] = None
+    assignee: Option[User] = None,
+    draft: Boolean
 )
 
 final case class PullRequestBase(
@@ -66,7 +67,8 @@ final case class CreatePullRequestData(
     head: String,
     base: String,
     body: String,
-    maintainer_can_modify: Option[Boolean] = Some(true)
+    maintainer_can_modify: Option[Boolean] = Some(true),
+    draft: Boolean
 ) extends CreatePullRequest
 
 final case class CreatePullRequestIssue(
@@ -103,8 +105,9 @@ final case object PRFilterOrderAsc  extends PRFilterDirection("asc")
 final case object PRFilterOrderDesc extends PRFilterDirection("desc")
 
 sealed trait NewPullRequest
-final case class NewPullRequestData(title: String, body: String) extends NewPullRequest
-final case class NewPullRequestIssue(issue: Int)                 extends NewPullRequest
+final case class NewPullRequestData(title: String, body: String, draft: Boolean)
+    extends NewPullRequest
+final case class NewPullRequestIssue(issue: Int) extends NewPullRequest
 
 final case class PullRequestReview(
     id: Long,

diff --git a/github4s/src/main/scala/github4s/interpreters/PullRequestsInterpreter.scala b/github4s/src/main/scala/github4s/interpreters/PullRequestsInterpreter.scala
@@ -72,8 +72,8 @@ class PullRequestsInterpreter[F[_]](implicit client: HttpClient[F]) extends Pull
       headers: Map[String, String]
   ): F[GHResponse[PullRequest]] = {
     val data: CreatePullRequest = newPullRequest match {
-      case NewPullRequestData(title, body) =>
-        CreatePullRequestData(title, head, base, body, maintainerCanModify)
+      case NewPullRequestData(title, body, draft) =>
+        CreatePullRequestData(title, head, base, body, maintainerCanModify, draft)
       case NewPullRequestIssue(issue) =>
         CreatePullRequestIssue(issue, head, base, maintainerCanModify)
     }

diff --git a/github4s/src/test/scala/github4s/unit/EncodersSpec.scala b/github4s/src/test/scala/github4s/unit/EncodersSpec.scala
@@ -67,7 +67,14 @@ class EncodersSpec extends AnyFlatSpec with Matchers with TestData {
 
   "CreatePullRequest encoder" should "encode the CreatePullRequestData" in {
     val createPullRequest: CreatePullRequest =
-      CreatePullRequestData(validIssueTitle, validHead, validBase, validCommitMsg, Some(false))
+      CreatePullRequestData(
+        validIssueTitle,
+        validHead,
+        validBase,
+        validCommitMsg,
+        Some(false),
+        draft
+      )
 
     val expectedJsonString =
       s"""
@@ -76,7 +83,8 @@ class EncodersSpec extends AnyFlatSpec with Matchers with TestData {
          |   "head": "$validHead",
          |   "base": "$validBase",
          |   "body": "$validCommitMsg",
-         |   "maintainer_can_modify": false
+         |   "maintainer_can_modify": false,
+         |   "draft": $draft
          | }
       """.stripMargin
 

diff --git a/github4s/src/test/scala/github4s/unit/PullRequestsSpec.scala b/github4s/src/test/scala/github4s/unit/PullRequestsSpec.scala
@@ -82,7 +82,8 @@ class PullRequestsSpec extends BaseSpec {
       validHead,
       validBase,
       "Please pull this in!",
-      Some(true)
+      Some(true),
+      draft
     )
 
     implicit val httpClientMock = httpClientMockPost[CreatePullRequestData, PullRequest](

diff --git a/github4s/src/test/scala/github4s/utils/TestData.scala b/github4s/src/test/scala/github4s/utils/TestData.scala
@@ -141,8 +141,11 @@ trait TestData {
   val validBase   = "master"
   val invalidBase = ""
 
-  val validNewPullRequestData   = NewPullRequestData("Amazing new feature", "Please pull this in!")
-  val invalidNewPullRequestData = NewPullRequestData("", "")
+  val draft = false
+
+  val validNewPullRequestData =
+    NewPullRequestData("Amazing new feature", "Please pull this in!", draft)
+  val invalidNewPullRequestData = NewPullRequestData("", "", draft)
 
   val validNewPullRequestIssue   = NewPullRequestIssue(31)
   val invalidNewPullRequestIssue = NewPullRequestIssue(5)
@@ -249,7 +252,8 @@ trait TestData {
     base = None,
     head = None,
     user = None,
-    assignee = None
+    assignee = None,
+    draft = draft
   )
 
   val pullRequestFile = PullRequestFile(

diff --git a/microsite/docs/pull_request.md b/microsite/docs/pull_request.md
@@ -132,7 +132,7 @@ import github4s.domain.NewPullRequestData
 val createPullRequestData = gh.pullRequests.createPullRequest(
   "47deg",
   "github4s",
-  NewPullRequestData("title", "body"),
+  NewPullRequestData("title", "body", draft = false),
   "my-branch",
   "base-branch",
   Some(true))