Merge pull request #2523 from ybasket/feature/pr-labels

Add support for PR labels

Author: exoego

docs/help.md

@@ -3,7 +3,7 @@
 All command line arguments for the `scala-steward` application.
 
 ```
-Usage: scala-steward --workspace <file> --repos-file <file> [--git-author-name <string>] --git-author-email <string> [--git-author-signing-key <string>] --git-ask-pass <file> [--sign-commits] [--vcs-type <vcs-type>] [--vcs-api-host <uri>] --vcs-login <string> [--do-not-fork] [--ignore-opts-files] [--env-var <name=value>]... [--process-timeout <duration>] [--whitelist <string>]... [--read-only <string>]... [--enable-sandbox | --disable-sandbox] [--max-buffer-size <integer>] [--repo-config <uri>]... [--disable-default-repo-config] [--scalafix-migrations <uri>]... [--disable-default-scalafix-migrations] [--artifact-migrations <uri>]... [--disable-default-artifact-migrations] [--cache-ttl <duration>] [--bitbucket-server-use-default-reviewers] [--gitlab-merge-when-pipeline-succeeds] [--github-app-id <integer> --github-app-key-file <file>] [--url-checker-test-url <uri>] [--default-maven-repo <string>] [--refresh-backoff-period <duration>]
+Usage: scala-steward --workspace <file> --repos-file <file> [--git-author-name <string>] --git-author-email <string> [--git-author-signing-key <string>] --git-ask-pass <file> [--sign-commits] [--vcs-type <vcs-type>] [--vcs-api-host <uri>] --vcs-login <string> [--do-not-fork] [--add-labels] [--ignore-opts-files] [--env-var <name=value>]... [--process-timeout <duration>] [--whitelist <string>]... [--read-only <string>]... [--enable-sandbox | --disable-sandbox] [--max-buffer-size <integer>] [--repo-config <uri>]... [--disable-default-repo-config] [--scalafix-migrations <uri>]... [--disable-default-scalafix-migrations] [--artifact-migrations <uri>]... [--disable-default-artifact-migrations] [--cache-ttl <duration>] [--bitbucket-server-use-default-reviewers] [--gitlab-merge-when-pipeline-succeeds] [--github-app-id <integer> --github-app-key-file <file>] [--url-checker-test-url <uri>] [--default-maven-repo <string>] [--refresh-backoff-period <duration>]
 
 
 
@@ -32,6 +32,8 @@ Options and flags:
         The user name for the git hoster
     --do-not-fork
         Whether to not push the update branches to a fork; default: false
+    --add-labels
+        Whether to add labels on pull or merge requests (if supported by git hoster)
     --ignore-opts-files
         Whether to remove ".jvmopts" and ".sbtopts" files before invoking the build tool
     --env-var <name=value>

modules/core/src/main/scala/org/scalasteward/core/application/Cli.scala

@@ -108,8 +108,14 @@ object Cli {
   private val doNotFork: Opts[Boolean] =
     flag("do-not-fork", "Whether to not push the update branches to a fork; default: false").orFalse
 
+  private val addPrLabels: Opts[Boolean] =
+    flag(
+      "add-labels",
+      "Whether to add labels on pull or merge requests (if supported by git hoster)"
+    ).orFalse
+
   private val vcsCfg: Opts[VCSCfg] =
-    (vcsType, vcsApiHost, vcsLogin, doNotFork).mapN(VCSCfg.apply)
+    (vcsType, vcsApiHost, vcsLogin, doNotFork, addPrLabels).mapN(VCSCfg.apply)
 
   private val ignoreOptsFiles: Opts[Boolean] =
     flag(

modules/core/src/main/scala/org/scalasteward/core/application/Config.scala

@@ -96,7 +96,8 @@ object Config {
       tpe: VCSType,
       apiHost: Uri,
       login: String,
-      doNotFork: Boolean
+      doNotFork: Boolean,
+      addLabels: Boolean
   )
 
   final case class ProcessCfg(

modules/core/src/main/scala/org/scalasteward/core/nurture/NurtureAlg.scala

@@ -196,6 +196,9 @@ final class NurtureAlg[F[_]](config: VCSCfg)(implicit
         filesWithOldVersion
       )
       pr <- vcsApiAlg.createPullRequest(data.repo, requestData)
+      _ <- vcsApiAlg
+        .labelPullRequest(data.repo, pr.number, requestData.labels)
+        .whenA(config.addLabels && requestData.labels.nonEmpty)
       prData = PullRequestData[Id](
         pr.html_url,
         data.baseSha1,

modules/core/src/main/scala/org/scalasteward/core/vcs/VCSApiAlg.scala

@@ -39,6 +39,8 @@ trait VCSApiAlg[F[_]] {
 
   def commentPullRequest(repo: Repo, number: PullRequestNumber, comment: String): F[Comment]
 
+  def labelPullRequest(repo: Repo, number: PullRequestNumber, labels: List[String]): F[Unit]
+
   final def createForkOrGetRepo(repo: Repo, doNotFork: Boolean): F[RepoOut] =
     if (doNotFork) getRepo(repo) else createFork(repo)
 

modules/core/src/main/scala/org/scalasteward/core/vcs/VCSSelection.scala

@@ -35,7 +35,10 @@ final class VCSSelection[F[_]](config: Config, user: AuthenticatedUser)(implicit
     F: MonadThrow[F]
 ) {
   private def gitHubApiAlg: GitHubApiAlg[F] =
-    new GitHubApiAlg[F](config.vcsCfg.apiHost, _ => github.authentication.addCredentials(user))
+    new GitHubApiAlg[F](
+      config.vcsCfg.apiHost,
+      _ => github.authentication.addCredentials(user)
+    )
 
   private def gitLabApiAlg: GitLabApiAlg[F] =
     new GitLabApiAlg[F](

modules/core/src/main/scala/org/scalasteward/core/vcs/bitbucket/BitbucketApiAlg.scala

@@ -25,10 +25,12 @@ import org.scalasteward.core.util.{HttpJsonClient, UnexpectedResponse}
 import org.scalasteward.core.vcs.VCSApiAlg
 import org.scalasteward.core.vcs.bitbucket.json._
 import org.scalasteward.core.vcs.data._
+import org.typelevel.log4cats.Logger
 
 /** https://developer.atlassian.com/bitbucket/api/2/reference/ */
 class BitbucketApiAlg[F[_]](config: VCSCfg, modify: Repo => Request[F] => F[Request[F]])(implicit
     client: HttpJsonClient[F],
+    logger: Logger[F],
     F: MonadThrow[F]
 ) extends VCSApiAlg[F] {
   private val url = new Url(config.apiHost)
@@ -105,4 +107,13 @@ class BitbucketApiAlg[F[_]](config: VCSCfg, modify: Repo => Request[F] => F[Requ
         modify(repo)
       )
       .map((cc: CreateComment) => Comment(cc.content.raw))
+
+  override def labelPullRequest(
+      repo: Repo,
+      number: PullRequestNumber,
+      labels: List[String]
+  ): F[Unit] =
+    logger.warn(
+      "Bitbucket does not support PR labels, remove --add-labels to make this warning disappear"
+    )
 }

modules/core/src/main/scala/org/scalasteward/core/vcs/bitbucketserver/BitbucketServerApiAlg.scala

@@ -26,13 +26,14 @@ import org.scalasteward.core.vcs.VCSApiAlg
 import org.scalasteward.core.vcs.bitbucketserver.Json.{PR, Reviewer, User}
 import org.scalasteward.core.vcs.data.PullRequestState.Open
 import org.scalasteward.core.vcs.data._
+import org.typelevel.log4cats.Logger
 
 /** https://docs.atlassian.com/bitbucket-server/rest/latest/bitbucket-rest.html */
 final class BitbucketServerApiAlg[F[_]](
     bitbucketApiHost: Uri,
     config: BitbucketServerCfg,
     modify: Repo => Request[F] => F[Request[F]]
-)(implicit client: HttpJsonClient[F], F: MonadThrow[F])
+)(implicit client: HttpJsonClient[F], logger: Logger[F], F: MonadThrow[F])
     extends VCSApiAlg[F] {
   private val url = new Url(bitbucketApiHost)
 
@@ -116,4 +117,13 @@ final class BitbucketServerApiAlg[F[_]](
     client
       .get[Json.Page[Json.PR]](url.listPullRequests(repo, s"refs/heads/$head"), modify(repo))
       .map(_.values.map(_.toPullRequestOut))
+
+  override def labelPullRequest(
+      repo: Repo,
+      number: PullRequestNumber,
+      labels: List[String]
+  ): F[Unit] =
+    logger.warn(
+      "Bitbucket does not support PR labels, remove --add-labels to make this warning disappear"
+    )
 }

modules/core/src/main/scala/org/scalasteward/core/vcs/data/NewPullRequestData.scala

@@ -33,6 +33,7 @@ final case class NewPullRequestData(
     body: String,
     head: String,
     base: Branch,
+    labels: List[String],
     draft: Boolean = false
 )
 
@@ -46,7 +47,8 @@ object NewPullRequestData {
       artifactIdToUrl: Map[String, Uri],
       releaseRelatedUrls: List[ReleaseRelatedUrl],
       filesWithOldVersion: List[String],
-      configParsingError: Option[String]
+      configParsingError: Option[String],
+      labels: List[String]
   ): String = {
     val artifacts = artifactsWithOptionalUrl(update, artifactIdToUrl)
     val migrations = edits.collect { case scalafixEdit: ScalafixEdit => scalafixEdit }
@@ -72,7 +74,7 @@ object NewPullRequestData {
         |
         |${details.map(_.toHtml).mkString("\n")}
         |
-        |${labelsFor(update, edits, filesWithOldVersion).mkString("labels: ", ", ", "")}
+        |${labels.mkString("labels: ", ", ", "")}
         |""".stripMargin.trim
   }
 
@@ -181,7 +183,8 @@ object NewPullRequestData {
       artifactIdToUrl: Map[String, Uri] = Map.empty,
       releaseRelatedUrls: List[ReleaseRelatedUrl] = List.empty,
       filesWithOldVersion: List[String] = List.empty
-  ): NewPullRequestData =
+  ): NewPullRequestData = {
+    val labels = labelsFor(data.update, edits, filesWithOldVersion)
     NewPullRequestData(
       title = git
         .commitMsgFor(data.update, data.repoConfig.commits, data.repoData.repo.branch)
@@ -192,11 +195,14 @@ object NewPullRequestData {
         artifactIdToUrl,
         releaseRelatedUrls,
         filesWithOldVersion,
-        data.repoData.cache.maybeRepoConfigParsingError
+        data.repoData.cache.maybeRepoConfigParsingError,
+        labels
       ),
       head = branchName,
-      base = data.baseBranch
+      base = data.baseBranch,
+      labels = labels
     )
+  }
 
   def updateType(update: Update): String = {
     val dependencies = update.dependencies

modules/core/src/main/scala/org/scalasteward/core/vcs/github/GitHubApiAlg.scala

@@ -77,4 +77,18 @@ final class GitHubApiAlg[F[_]](
     client
       .postWithBody(url.comments(repo, number), Comment(comment), modify(repo))
 
+  /** https://docs.github.com/en/rest/reference/issues#add-labels-to-an-issue */
+  override def labelPullRequest(
+      repo: Repo,
+      number: PullRequestNumber,
+      labels: List[String]
+  ): F[Unit] =
+    client
+      .postWithBody[io.circe.Json, GitHubLabels](
+        url.issueLabels(repo, number),
+        GitHubLabels(labels),
+        modify(repo)
+      )
+      .adaptErr(SecondaryRateLimitExceeded.fromThrowable)
+      .void
 }

modules/core/src/main/scala/org/scalasteward/core/vcs/github/GitHubLabels.scala

@@ -0,0 +1,26 @@
+/*
+ * Copyright 2018-2022 Scala Steward contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.scalasteward.core.vcs.github
+
+import io.circe.Encoder
+import io.circe.generic.semiauto.deriveEncoder
+
+case class GitHubLabels(labels: List[String])
+
+object GitHubLabels {
+  implicit val gitHubLabelsEncoder: Encoder[GitHubLabels] = deriveEncoder
+}

modules/core/src/main/scala/org/scalasteward/core/vcs/github/Url.scala

@@ -39,6 +39,9 @@ class Url(apiHost: Uri) {
   def pull(repo: Repo, number: PullRequestNumber): Uri =
     repos(repo) / "pulls" / number.toString
 
+  def issueLabels(repo: Repo, number: PullRequestNumber): Uri =
+    repos(repo) / "issues" / number.toString / "labels"
+
   def repos(repo: Repo): Uri =
     apiHost / "repos" / repo.owner / repo.repo
 

modules/core/src/main/scala/org/scalasteward/core/vcs/gitlab/GitLabApiAlg.scala

@@ -235,4 +235,17 @@ final class GitLabApiAlg[F[_]](
   ): F[Comment] =
     client.postWithBody(url.comments(repo, number), Comment(comment), modify(repo))
 
+  // https://docs.gitlab.com/ee/api/merge_requests.html#update-mr
+  override def labelPullRequest(
+      repo: Repo,
+      number: PullRequestNumber,
+      labels: List[String]
+  ): F[Unit] =
+    client
+      .putWithBody[Json, Json](
+        url.existingMergeRequest(repo, number),
+        Json.obj("labels" := labels.mkString(",")),
+        modify(repo)
+      )
+      .void
 }

modules/core/src/test/scala/org/scalasteward/core/vcs/VCSExtraAlgTest.scala

@@ -59,7 +59,13 @@ class VCSExtraAlgTest extends FunSuite {
   }
 
   test("getBranchCompareUrl: github on prem") {
-    val config = VCSCfg(VCSType.GitHub, uri"https://github.on-prem.com/", "", doNotFork = false)
+    val config = VCSCfg(
+      VCSType.GitHub,
+      uri"https://github.on-prem.com/",
+      "",
+      doNotFork = false,
+      addLabels = false
+    )
     val githubOnPremVcsExtraAlg = VCSExtraAlg.create[IO](config)
 
     assertEquals(

modules/core/src/test/scala/org/scalasteward/core/vcs/bitbucket/BitbucketApiAlgTest.scala

@@ -9,6 +9,7 @@ import org.http4s.circe._
 import org.http4s.client.Client
 import org.http4s.dsl.io._
 import org.http4s.implicits._
+import org.scalasteward.core.TestInstances.ioLogger
 import org.scalasteward.core.git.Sha1.HexString
 import org.scalasteward.core.git._
 import org.scalasteward.core.mock.MockConfig.config
@@ -262,7 +263,8 @@ class BitbucketApiAlgTest extends FunSuite {
       "scala-steward-pr",
       "body",
       "master",
-      master
+      master,
+      Nil
     )
     val pr = bitbucketApiAlg.createPullRequest(repo, data).unsafeRunSync()
     assertEquals(pr, pullRequest)

modules/core/src/test/scala/org/scalasteward/core/vcs/bitbucketserver/BitbucketServerApiAlgTest.scala

@@ -7,6 +7,7 @@ import org.http4s.client.Client
 import org.http4s.dsl.io._
 import org.http4s.implicits._
 import org.http4s.{HttpRoutes, Uri}
+import org.scalasteward.core.TestInstances.ioLogger
 import org.scalasteward.core.application.Config.BitbucketServerCfg
 import org.scalasteward.core.git.Branch
 import org.scalasteward.core.mock.MockConfig.config

modules/core/src/test/scala/org/scalasteward/core/vcs/data/NewPullRequestDataTest.scala

@@ -31,6 +31,12 @@ class NewPullRequestDataTest extends FunSuite {
             |  "body" : "Updates ch.qos.logback:logback-classic from 1.2.0 to 1.2.3.\n\n\nI'll automatically update this PR to resolve conflicts as long as you don't change it yourself.\n\nIf you'd like to skip this version, you can just close this PR. If you have any feedback, just mention me in the comments below.\n\nConfigure Scala Steward for your repository with a [`.scala-steward.conf`](https://github.com/scala-steward-org/scala-steward/blob/${org.scalasteward.core.BuildInfo.gitHeadCommit}/docs/repo-specific-configuration.md) file.\n\nHave a fantastic day writing Scala!\n\n<details>\n<summary>Adjust future updates</summary>\n\nAdd this to your `.scala-steward.conf` file to ignore future updates of this dependency:\n```\nupdates.ignore = [ { groupId = \"ch.qos.logback\", artifactId = \"logback-classic\" } ]\n```\nOr, add this to slow down future updates of this dependency:\n```\ndependencyOverrides = [{\n  pullRequests = { frequency = \"@monthly\" },\n  dependency = { groupId = \"ch.qos.logback\", artifactId = \"logback-classic\" }\n}]\n```\n</details>\n\nlabels: library-update, early-semver-patch, semver-spec-patch, commit-count:0",
             |  "head" : "scala-steward:update/logback-classic-1.2.3",
             |  "base" : "master",
+            |  "labels" : [
+            |    "library-update",
+            |    "early-semver-patch",
+            |    "semver-spec-patch",
+            |    "commit-count:0"
+            |  ],
             |  "draft" : false
             |}""".stripMargin
     assertEquals(obtained, expected)
@@ -56,6 +62,12 @@ class NewPullRequestDataTest extends FunSuite {
             |  "body" : "Updates ch.qos.logback:logback-classic from 1.2.0 to 1.2.3.\n\n\nI'll automatically update this PR to resolve conflicts as long as you don't change it yourself.\n\nIf you'd like to skip this version, you can just close this PR. If you have any feedback, just mention me in the comments below.\n\nConfigure Scala Steward for your repository with a [`.scala-steward.conf`](https://github.com/scala-steward-org/scala-steward/blob/${org.scalasteward.core.BuildInfo.gitHeadCommit}/docs/repo-specific-configuration.md) file.\n\nHave a fantastic day writing Scala!\n\n<details>\n<summary>Adjust future updates</summary>\n\nAdd this to your `.scala-steward.conf` file to ignore future updates of this dependency:\n```\nupdates.ignore = [ { groupId = \"ch.qos.logback\", artifactId = \"logback-classic\" } ]\n```\nOr, add this to slow down future updates of this dependency:\n```\ndependencyOverrides = [{\n  pullRequests = { frequency = \"@monthly\" },\n  dependency = { groupId = \"ch.qos.logback\", artifactId = \"logback-classic\" }\n}]\n```\n</details>\n<details>\n<summary>Note that the Scala Steward config file `.scala-steward.conf` wasn't parsed correctly</summary>\n\n```\nFailed to parse .scala-steward.conf\n```\n</details>\n\nlabels: library-update, early-semver-patch, semver-spec-patch, commit-count:0",
             |  "head" : "scala-steward:update/logback-classic-1.2.3",
             |  "base" : "master",
+            |  "labels" : [
+            |    "library-update",
+            |    "early-semver-patch",
+            |    "semver-spec-patch",
+            |    "commit-count:0"
+            |  ],
             |  "draft" : false
             |}""".stripMargin
     assertEquals(obtained, expected)

modules/core/src/test/scala/org/scalasteward/core/vcs/github/GitHubApiAlgTest.scala

@@ -88,6 +88,19 @@ class GitHubApiAlgTest extends FunSuite {
             "body": "Superseded by #1234"
           } """)
 
+      case POST -> Root / "repos" / "fthomas" / "base.g8" / "issues" / IntVar(_) / "labels" =>
+        // Response taken from https://docs.github.com/en/rest/reference/issues#labels, is ignored
+        Created(json"""[
+          {
+            "id": 208045946,
+            "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=",
+            "url": "https://api.github.com/repos/fthomas/base.g8/labels/bug",
+            "name": "bug",
+            "description": "Something isn't working",
+            "color": "f29513",
+            "default": true
+          }]""")
+
       case req =>
         println(req.toString())
         NotFound()
@@ -209,4 +222,12 @@ class GitHubApiAlgTest extends FunSuite {
       .unsafeRunSync()
     assertEquals(comment, Comment("Superseded by #1234"))
   }
+
+  test("labelPullRequest") {
+    val result = gitHubApiAlg
+      .labelPullRequest(repo, PullRequestNumber(1347), List("A", "B"))
+      .attempt
+      .unsafeRunSync()
+    assert(result.isRight)
+  }
 }

modules/core/src/test/scala/org/scalasteward/core/vcs/gitlab/GitLabApiAlgTest.scala

@@ -206,6 +206,14 @@ class GitLabApiAlgTest extends FunSuite {
     assertEquals(comment, Comment("Superseded by #1234"))
   }
 
+  test("labelPullRequest") {
+    val result = gitlabApiAlg
+      .labelPullRequest(Repo("foo", "bar"), PullRequestNumber(150), List("A", "B"))
+      .attempt
+      .unsafeRunSync()
+    assert(result.isRight)
+  }
+
   val getMr = json"""
     {
       "id": 26328,
@@ -253,7 +261,7 @@ class GitLabApiAlgTest extends FunSuite {
       ],
       "source_project_id": 466,
       "target_project_id": 466,
-      "labels": [],
+      "labels": ["A", "B"],
       "work_in_progress": false,
       "milestone": null,
       "merge_when_pipeline_succeeds": true,

modules/core/src/test/scala/org/scalasteward/core/vcs/gitlab/MergeRequestPayloadTest.scala

@@ -13,7 +13,8 @@ class MergeRequestPayloadTest extends FunSuite {
     "Test MR title",
     "Test MR body",
     "source",
-    master
+    master,
+    Nil
   )
   private val id = "123"
   private val projectId = 321L