Add ability to add assignees and reviewers for GitLab and GitHub (#2953)

Notable changes:

**Gitlab**

- Adding reviewers and assignees is possible with "create MR" request by
  providing lists of **user ids** for reviewers and assignees and it was
  implemented by
  - getting usernames from config
  - fetching user ids by usernames using /users API

**GitHub**

- GitHub does not support creating PR and add reviewers and assignees in
  one call - adding was implemented as separate calls.
- Team reviewers are specified with `organization/team`

**Other**

- Azure and BitBucket do not support assignees - warning was added

- Azure and BitBucket support reviewers but it was not implemented at the
  time, instead warning was added saying that implementation is missing
  for now

- Gitea supports both reviewers and assignees, warning was added saying
  that implementation is missing for now

Author: danielleontiev

docs/repo-specific-configuration.md

@@ -164,6 +164,16 @@ dependencyOverrides = [
     pullRequests = { frequency = "14 day" },
   }
 ]
+
+# Assign people from the list to the pull request or request a review.
+# Currently supported only for GitLab and GitHub.
+# GitLab users - free version of GitLab only supports one assignee and one reviewer, others will be ignored.
+# GitHub users - to request review from a team inside your organisation it should be specified
+# like "yourOrg/yourTeam" in `reviewers` config below.
+# Please note that only accounts with write access to the repository (Developer role for GitLab) are able
+# to add assignees or request reviews. Consequently, it won't work for public @scala-steward instance on GitHub.
+assignees = [ "username1", "username2" ]
+reviewers = [ "username1", "username2" ]
 ```
 
 The version information given in the patterns above can be in two formats:

modules/core/src/main/scala/org/scalasteward/core/forge/ForgeSelection.scala

@@ -17,7 +17,7 @@
 package org.scalasteward.core.forge
 
 import cats.syntax.all._
-import cats.{Applicative, MonadThrow}
+import cats.{Applicative, MonadThrow, Parallel}
 import org.http4s.headers.Authorization
 import org.http4s.{BasicCredentials, Header, Request}
 import org.scalasteward.core.application.Config
@@ -35,7 +35,7 @@ import org.typelevel.ci._
 import org.typelevel.log4cats.Logger
 
 object ForgeSelection {
-  def forgeApiAlg[F[_]](
+  def forgeApiAlg[F[_]: Parallel](
       forgeCfg: ForgeCfg,
       forgeSpecificCfg: ForgeSpecificCfg,
       user: AuthenticatedUser

modules/core/src/main/scala/org/scalasteward/core/forge/azurerepos/AzureReposApiAlg.scala

@@ -28,26 +28,33 @@ import org.scalasteward.core.forge.azurerepos.JsonCodec._
 import org.scalasteward.core.forge.data._
 import org.scalasteward.core.git.Branch
 import org.scalasteward.core.util.HttpJsonClient
+import org.typelevel.log4cats.Logger
 
 final class AzureReposApiAlg[F[_]](
     azureAPiHost: Uri,
     config: AzureReposCfg,
     modify: Repo => Request[F] => F[Request[F]]
-)(implicit client: HttpJsonClient[F], monadErrorF: MonadThrow[F])
+)(implicit client: HttpJsonClient[F], logger: Logger[F], F: MonadThrow[F])
     extends ForgeApiAlg[F] {
 
   private val url = new Url(azureAPiHost, config.organization.getOrElse(""))
 
   override def createFork(repo: Repo): F[RepoOut] =
-    monadErrorF.raiseError(new NotImplementedError(s"createFork($repo)"))
+    F.raiseError(new NotImplementedError(s"createFork($repo)"))
 
   // https://docs.microsoft.com/en-us/rest/api/azure/devops/git/pull-requests/create?view=azure-devops-rest-7.1
-  override def createPullRequest(repo: Repo, data: NewPullRequestData): F[PullRequestOut] =
-    client.postWithBody[PullRequestOut, PullRequestPayload](
+  override def createPullRequest(repo: Repo, data: NewPullRequestData): F[PullRequestOut] = {
+    val create = client.postWithBody[PullRequestOut, PullRequestPayload](
       url.pullRequests(repo),
       PullRequestPayload.from(data),
       modify(repo)
     )
+    for {
+      _ <- F.whenA(data.assignees.nonEmpty)(warnIfAssigneesAreUsed)
+      _ <- F.whenA(data.reviewers.nonEmpty)(warnIfReviewersAreUsed)
+      pullRequestOut <- create
+    } yield pullRequestOut
+  }
 
   // https://docs.microsoft.com/en-us/rest/api/azure/devops/git/pull-requests/update?view=azure-devops-rest-7.1
   override def closePullRequest(repo: Repo, number: PullRequestNumber): F[PullRequestOut] =
@@ -96,4 +103,11 @@ final class AzureReposApiAlg[F[_]](
         modify(repo)
       )
       .void
+
+  private def warnIfAssigneesAreUsed =
+    logger.warn("assignees are not supported by AzureRepos")
+
+  private def warnIfReviewersAreUsed =
+    logger.warn("reviewers are not implemented yet for AzureRepos")
+
 }

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

@@ -73,20 +73,27 @@ class BitbucketApiAlg[F[_]](
       if (bitbucketCfg.useDefaultReviewers) getDefaultReviewers(repo)
       else F.pure(List.empty[Reviewer])
 
-    defaultReviewers
-      .map(reviewers =>
-        CreatePullRequestRequest(
-          data.title,
-          Branch(data.head),
-          Repo(sourceBranchOwner, repo.repo, repo.branch),
-          data.base,
-          data.body,
-          reviewers
+    val create: F[PullRequestOut] =
+      defaultReviewers
+        .map(reviewers =>
+          CreatePullRequestRequest(
+            data.title,
+            Branch(data.head),
+            Repo(sourceBranchOwner, repo.repo, repo.branch),
+            data.base,
+            data.body,
+            reviewers
+          )
         )
-      )
-      .flatMap { payload =>
-        client.postWithBody(url.pullRequests(repo), payload, modify(repo))
-      }
+        .flatMap { payload =>
+          client.postWithBody(url.pullRequests(repo), payload, modify(repo))
+        }
+
+    for {
+      _ <- F.whenA(data.assignees.nonEmpty)(warnIfAssigneesAreUsed)
+      _ <- F.whenA(data.reviewers.nonEmpty)(warnIfReviewersAreUsed)
+      pullRequestOut <- create
+    } yield pullRequestOut
   }
 
   override def getBranch(repo: Repo, branch: Branch): F[BranchOut] =
@@ -133,4 +140,10 @@ class BitbucketApiAlg[F[_]](
     logger.warn(
       "Bitbucket does not support PR labels, remove --add-labels to make this warning disappear"
     )
+
+  private def warnIfAssigneesAreUsed =
+    logger.warn("assignees are not supported by Bitbucket")
+
+  private def warnIfReviewersAreUsed =
+    logger.warn("reviewers are not implemented yet for Bitbucket")
 }

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

@@ -68,6 +68,8 @@ final class BitbucketServerApiAlg[F[_]](
 
     for {
       reviewers <- useDefaultReviewers(repo)
+      _ <- F.whenA(data.assignees.nonEmpty)(warnIfAssigneesAreUsed)
+      _ <- F.whenA(data.reviewers.nonEmpty)(warnIfReviewersAreUsed)
       req = Json.NewPR(
         title = data.title,
         description = data.body,
@@ -127,4 +129,10 @@ final class BitbucketServerApiAlg[F[_]](
     logger.warn(
       "Bitbucket does not support PR labels, remove --add-labels to make this warning disappear"
     )
+
+  private def warnIfAssigneesAreUsed =
+    logger.warn("assignees are not supported by Bitbucket")
+
+  private def warnIfReviewersAreUsed =
+    logger.warn("reviewers are not implemented yet for Bitbucket")
 }

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

@@ -37,6 +37,8 @@ final case class NewPullRequestData(
     head: String,
     base: Branch,
     labels: List[String],
+    assignees: List[String],
+    reviewers: List[String],
     draft: Boolean = false
 )
 
@@ -246,7 +248,9 @@ object NewPullRequestData {
       ),
       head = branchName,
       base = data.baseBranch,
-      labels = labels
+      labels = labels,
+      assignees = data.repoConfig.assignees,
+      reviewers = data.repoConfig.reviewers
     )
 
   def updateTypeLabels(anUpdate: Update): List[String] = {

modules/core/src/main/scala/org/scalasteward/core/forge/gitea/GiteaApiAlg.scala

@@ -26,6 +26,7 @@ import org.scalasteward.core.application.Config.ForgeCfg
 import org.scalasteward.core.data.Repo
 import org.scalasteward.core.forge.ForgeApiAlg
 import org.scalasteward.core.forge.data._
+import org.typelevel.log4cats.Logger
 
 // docs
 // - https://docs.gitea.io/en-us/api-usage/
@@ -117,10 +118,11 @@ object GiteaApiAlg {
   implicit val attachLabelReqCodec: Codec[AttachLabelReq] = deriveCodec
 }
 
-final class GiteaApiAlg[F[_]: MonadThrow: HttpJsonClient](
+final class GiteaApiAlg[F[_]: HttpJsonClient](
     vcs: ForgeCfg,
     modify: Repo => Request[F] => F[Request[F]]
-) extends ForgeApiAlg[F] {
+)(implicit logger: Logger[F], F: MonadThrow[F])
+    extends ForgeApiAlg[F] {
   import GiteaApiAlg._
 
   def client: HttpJsonClient[F] = implicitly
@@ -162,6 +164,8 @@ final class GiteaApiAlg[F[_]: MonadThrow: HttpJsonClient](
 
   override def createPullRequest(repo: Repo, data: NewPullRequestData): F[PullRequestOut] =
     for {
+      _ <- F.whenA(data.assignees.nonEmpty)(warnIfAssigneesAreUsed)
+      _ <- F.whenA(data.reviewers.nonEmpty)(warnIfReviewersAreUsed)
       labels <- getOrCreateLabel(repo, data.labels.toVector)
       create = CreatePullRequestOption(
         assignee = none,
@@ -302,4 +306,10 @@ final class GiteaApiAlg[F[_]: MonadThrow: HttpJsonClient](
       }
     go(1, Vector.empty)
   }
+
+  private def warnIfAssigneesAreUsed =
+    logger.warn("assignees are not implemented yet for Gitea")
+
+  private def warnIfReviewersAreUsed =
+    logger.warn("reviewers are not implemented yet for Gitea")
 }

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

@@ -25,12 +25,15 @@ import org.scalasteward.core.forge.data._
 import org.scalasteward.core.forge.github.GitHubException._
 import org.scalasteward.core.git.Branch
 import org.scalasteward.core.util.HttpJsonClient
+import org.typelevel.log4cats.Logger
+import io.circe.Json
 
 final class GitHubApiAlg[F[_]](
     gitHubApiHost: Uri,
     modify: Repo => Request[F] => F[Request[F]]
 )(implicit
     client: HttpJsonClient[F],
+    logger: Logger[F],
     F: MonadThrow[F]
 ) extends ForgeApiAlg[F] {
   private val url = new Url(gitHubApiHost)
@@ -42,11 +45,20 @@ final class GitHubApiAlg[F[_]](
     }
 
   /** https://developer.github.com/v3/pulls/#create-a-pull-request */
-  override def createPullRequest(repo: Repo, data: NewPullRequestData): F[PullRequestOut] =
-    client
+  override def createPullRequest(repo: Repo, data: NewPullRequestData): F[PullRequestOut] = {
+    val create = client
       .postWithBody[PullRequestOut, NewPullRequestData](url.pulls(repo), data, modify(repo))
       .adaptErr(SecondaryRateLimitExceeded.fromThrowable)
 
+    for {
+      pullRequestOut <- create
+      _ <-
+        F.whenA(data.assignees.nonEmpty)(addAssignees(repo, pullRequestOut.number, data.assignees))
+      _ <-
+        F.whenA(data.reviewers.nonEmpty)(addReviewers(repo, pullRequestOut.number, data.reviewers))
+    } yield pullRequestOut
+  }
+
   /** https://developer.github.com/v3/repos/branches/#get-branch */
   override def getBranch(repo: Repo, branch: Branch): F[BranchOut] =
     client.get(url.branches(repo, branch), modify(repo))
@@ -92,4 +104,39 @@ final class GitHubApiAlg[F[_]](
       )
       .adaptErr(SecondaryRateLimitExceeded.fromThrowable)
       .void
+
+  private def addAssignees(
+      repo: Repo,
+      number: PullRequestNumber,
+      assignees: List[String]
+  ): F[Unit] =
+    client
+      .postWithBody[Json, GitHubAssignees](
+        url.assignees(repo, number),
+        GitHubAssignees(assignees),
+        modify(repo)
+      )
+      .void
+      .handleErrorWith { error =>
+        logger.error(error)(s"cannot add assignees '${assignees.mkString(",")}' to PR '$number'")
+      }
+
+  private def addReviewers(
+      repo: Repo,
+      number: PullRequestNumber,
+      reviewers: List[String]
+  ): F[Unit] =
+    client
+      .postWithBody[Json, GitHubReviewers](
+        url.reviewers(repo, number),
+        GitHubReviewers(reviewers),
+        modify(repo)
+      )
+      .void
+      .handleErrorWith { error =>
+        logger.error(error)(
+          s"cannot request review from '${reviewers.mkString(",")}' for PR '$number'"
+        )
+      }
+
 }

modules/core/src/main/scala/org/scalasteward/core/forge/github/GitHubAssignees.scala

@@ -0,0 +1,26 @@
+/*
+ * Copyright 2018-2023 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.forge.github
+
+import io.circe.Encoder
+import io.circe.generic.semiauto.deriveEncoder
+
+case class GitHubAssignees(assignees: List[String])
+
+object GitHubAssignees {
+  implicit val gitHubAssigneesEncoder: Encoder[GitHubAssignees] = deriveEncoder
+}

modules/core/src/main/scala/org/scalasteward/core/forge/github/GitHubReviewers.scala

@@ -0,0 +1,39 @@
+/*
+ * Copyright 2018-2023 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.forge.github
+
+import io.circe.Encoder
+
+class GitHubReviewers private (
+    val reviewers: List[String],
+    val teamReviewers: List[String]
+)
+
+object GitHubReviewers {
+  def apply(reviewersFromConfig: List[String]): GitHubReviewers = {
+    val (simpleReviewers, teamReviewers) = reviewersFromConfig.partitionMap {
+      case s"$_/$team" => Right(team)
+      case user        => Left(user)
+    }
+    new GitHubReviewers(simpleReviewers, teamReviewers)
+  }
+
+  implicit val gitHubReviewersEncoder: Encoder[GitHubReviewers] =
+    Encoder.forProduct2("reviewers", "team_reviewers")(gitHubReviewers =>
+      (gitHubReviewers.reviewers, gitHubReviewers.teamReviewers)
+    )
+}