Merge pull request #3017 from scala-steward-org/topic/use-git-trailers-option

Use Git's `--trailer` for commit message trailers

Author: fthomas

modules/core/src/main/scala/org/scalasteward/core/edit/hooks/HookExecutor.scala

@@ -74,7 +74,7 @@ final class HookExecutor[F[_]](implicit
       }
       commitMessage = hook
         .commitMessage(update)
-        .withParagraph(s"Executed command: ${hook.command.mkString_(" ")}")
+        .appendParagraph(s"Executed command: ${hook.command.mkString_(" ")}")
       maybeHookCommit <- gitAlg.commitAllIfDirty(repo, commitMessage)
       maybeBlameIgnoreCommit <-
         maybeHookCommit.flatTraverse(addToGitBlameIgnoreRevs(repo, repoDir, hook, _, commitMessage))

modules/core/src/main/scala/org/scalasteward/core/git/CommitMsg.scala

@@ -26,16 +26,14 @@ final case class CommitMsg(
     body: List[String] = Nil,
     coAuthoredBy: List[Author] = Nil
 ) {
-  def toNel: Nel[String] =
-    Nel(title, body ++ trailers)
+  def paragraphs: Nel[String] =
+    Nel(title, body)
 
-  def withParagraph(paragraph: String): CommitMsg =
+  def appendParagraph(paragraph: String): CommitMsg =
     copy(body = body :+ paragraph)
 
-  private def trailers: Option[String] = {
-    val lines = coAuthoredBy.map(author => s"Co-authored-by: ${author.show}")
-    Nel.fromList(lines).map(_.mkString_("\n"))
-  }
+  def trailers: List[(String, String)] =
+    coAuthoredBy.map(author => ("Co-authored-by", author.show))
 }
 
 object CommitMsg {

modules/core/src/main/scala/org/scalasteward/core/git/FileGitAlg.scala

@@ -64,8 +64,9 @@ final class FileGitAlg[F[_]](config: GitCfg)(implicit
     fileAlg.isDirectory(repo / ".git")
 
   override def commitAll(repo: File, message: CommitMsg): F[Commit] = {
-    val messages = message.toNel.foldMap(m => List("-m", m))
-    git_("commit" :: "--all" :: sign :: messages: _*)(repo) >>
+    val messages = message.paragraphs.foldMap(m => List("-m", m))
+    val trailers = message.trailers.foldMap { case (k, v) => List("--trailer", s"$k=$v") }
+    git_("commit" :: "--all" :: sign :: messages ++ trailers: _*)(repo) >>
       latestSha1(repo, Branch.head).map(Commit.apply)
   }
 

modules/core/src/test/scala/org/scalasteward/core/edit/scalafix/ScalafixMigrationTest.scala

@@ -3,7 +3,7 @@ package org.scalasteward.core.edit.scalafix
 import io.circe.config.parser
 import munit.FunSuite
 import org.scalasteward.core.edit.scalafix.ScalafixMigration.{ExecutionOrder, Target}
-import org.scalasteward.core.util.Nel
+import org.scalasteward.core.git.{Author, CommitMsg}
 
 class ScalafixMigrationTest extends FunSuite {
   test("commitMessage") {
@@ -18,11 +18,13 @@ class ScalafixMigrationTest extends FunSuite {
          |  authors: ["Jane Doe <[email protected]>"]
          |}""".stripMargin
     )
-    val obtained = migration.map(_.commitMessage(Right(())).toNel)
-    val expected = Nel.of(
-      "Applied Scalafix rule(s) github:typelevel/cats/Cats_v2_2_0?sha=v2.2.0",
-      "See https://github.com/typelevel/cats/blob/v2.2.0/scalafix/README.md#migration-to-cats-v220 for details",
-      "Co-authored-by: Jane Doe <[email protected]>"
+    val obtained = migration.map(_.commitMessage(Right(())))
+    val expected = CommitMsg(
+      title = "Applied Scalafix rule(s) github:typelevel/cats/Cats_v2_2_0?sha=v2.2.0",
+      body = List(
+        "See https://github.com/typelevel/cats/blob/v2.2.0/scalafix/README.md#migration-to-cats-v220 for details"
+      ),
+      coAuthoredBy = List(Author("Jane Doe", "[email protected]"))
     )
     assertEquals(obtained, Right(expected))
   }

modules/core/src/test/scala/org/scalasteward/core/git/FileGitAlgTest.scala

@@ -108,7 +108,8 @@ class FileGitAlgTest extends CatsEffectSuite {
       c1 <- ioGitAlg.containsChanges(repo)
       _ <- ioFileAlg.writeFile(repo / "test.txt", "hello world")
       c2 <- ioGitAlg.containsChanges(repo)
-      _ <- ioGitAlg.commitAllIfDirty(repo, CommitMsg("Modify test.txt"))
+      m2 = CommitMsg("Modify test.txt", coAuthoredBy = List(Author("name", "email")))
+      _ <- ioGitAlg.commitAllIfDirty(repo, m2)
       c3 <- ioGitAlg.containsChanges(repo)
       _ = assertEquals((c1, c2, c3), (false, true, false))
     } yield ()