Merge pull request #478 from alejandrohdezma/feature/default-branch

alejandrohdezma · web-flow · commit ca3a75e0bbe2 · 2022-11-07T20:39:26.000+01:00
Add information about repository's default branch
diff --git a/docs/README.md b/docs/README.md
@@ -1,7 +1,5 @@
 # @DESCRIPTION@
 
-[![][maven-badge]][maven] [![][steward-badge]][steward]
-
 This plugin enables several settings automatically by downloading them from Github:
 
 - `homepage`: Retrieved from the Github repository's information.
@@ -33,10 +31,4 @@ If you want to know more about all the plugin's features, please head on to [its
 
 ## Contributors for this project
 
-@CONTRIBUTORS_TABLE@
-
-[maven]: https://search.maven.org/search?q=g:%20com.alejandrohdezma%20AND%20a:sbt-github
-[maven-badge]: https://maven-badges.herokuapp.com/maven-central/com.alejandrohdezma/sbt-github/badge.svg?kill_cache=1
-
-[steward]: https://scala-steward.org
-[steward-badge]: https://img.shields.io/badge/Scala_Steward-helping-brightgreen.svg?style=flat&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAQCAMAAAARSr4IAAAAVFBMVEUAAACHjojlOy5NWlrKzcYRKjGFjIbp293YycuLa3pYY2LSqql4f3pCUFTgSjNodYRmcXUsPD/NTTbjRS+2jomhgnzNc223cGvZS0HaSD0XLjbaSjElhIr+AAAAAXRSTlMAQObYZgAAAHlJREFUCNdNyosOwyAIhWHAQS1Vt7a77/3fcxxdmv0xwmckutAR1nkm4ggbyEcg/wWmlGLDAA3oL50xi6fk5ffZ3E2E3QfZDCcCN2YtbEWZt+Drc6u6rlqv7Uk0LdKqqr5rk2UCRXOk0vmQKGfc94nOJyQjouF9H/wCc9gECEYfONoAAAAASUVORK5CYII=
+@CONTRIBUTORS_TABLE@
diff --git a/modules/sbt-github-mdoc/src/main/scala/com/alejandrohdezma/sbt/github/mdoc/SbtGithubMdocPlugin.scala b/modules/sbt-github-mdoc/src/main/scala/com/alejandrohdezma/sbt/github/mdoc/SbtGithubMdocPlugin.scala
@@ -45,6 +45,7 @@ import mdoc.MdocPlugin.autoImport.mdocVariables
   *   - '''ORG_URL''': Set to the value of `organizationHomepage` setting (Github's organization homepage, or owner's in
   *     case organization is empty and `populateOrganizationWithOwner` is `true`).
   *   - '''REPO''': Set to the repository's path: "owner/repo".
+  *   - '''DEFAULT_BRANCH''': Set to the repository's default branch.
   *   - '''START_YEAR''': Set to the value of the `startYear` setting.
   *   - '''YEAR_RANGE''': Set to the value of the `yearRange` setting
   *   - '''COPYRIGHT_OWNER''': Set to the value of `ORG_NAME <ORG_URL>` if `ORG_URL` is present or just `ORG_NAME` in
@@ -88,6 +89,7 @@ object SbtGithubMdocPlugin extends AutoPlugin {
       mdocVariables ++= Map(
         "NAME"                -> displayName.value,
         "REPO"                -> repository.value.map(_.name).getOrElse(""),
+        "DEFAULT_BRANCH"      -> repository.value.map(_.defaultBranch).getOrElse(""),
         "LICENSE"             -> licenses.value.headOption.map(_._1).getOrElse(""),
         "ORG_NAME"            -> organizationName.value,
         "DESCRIPTION"         -> description.value,
diff --git a/modules/sbt-github-mdoc/src/sbt-test/sbt-github-mdoc/remove-version-timestamp/github/repository.json b/modules/sbt-github-mdoc/src/sbt-test/sbt-github-mdoc/remove-version-timestamp/github/repository.json
@@ -2,6 +2,7 @@
   "name": "repo",
   "full_name": "user1/repo",
   "created_at": "2018-01-01T13:30:30Z",
+  "default_branch": "name",
   "owner": {
     "url": "{{base_directory}}/user1.json"
   },
diff --git a/modules/sbt-github-mdoc/src/sbt-test/sbt-github-mdoc/simple/DOCS.md b/modules/sbt-github-mdoc/src/sbt-test/sbt-github-mdoc/simple/DOCS.md
@@ -2,6 +2,8 @@ sbt-github
 
 user1/repo
 
+name
+
 An awesome description
 
 MIT
diff --git a/modules/sbt-github-mdoc/src/sbt-test/sbt-github-mdoc/simple/docs/DOCS.md b/modules/sbt-github-mdoc/src/sbt-test/sbt-github-mdoc/simple/docs/DOCS.md
@@ -2,6 +2,8 @@
 
 @REPO@
 
+@DEFAULT_BRANCH@
+
 @DESCRIPTION@
 
 @LICENSE@
diff --git a/modules/sbt-github-mdoc/src/sbt-test/sbt-github-mdoc/simple/github/repository.json b/modules/sbt-github-mdoc/src/sbt-test/sbt-github-mdoc/simple/github/repository.json
@@ -5,6 +5,7 @@
   "owner": {
     "url": "{{base_directory}}/user1.json"
   },
+  "default_branch": "name",
   "html_url": "https://github.com/user1/repo",
   "description": "An awesome description",
   "collaborators_url": "{{base_directory}}/collaborators.json",
diff --git a/modules/sbt-github/src/main/scala/com/alejandrohdezma/sbt/github/github/Repository.scala b/modules/sbt-github/src/main/scala/com/alejandrohdezma/sbt/github/github/Repository.scala
@@ -42,6 +42,7 @@ final case class Repository(
     license: License,
     url: URL,
     startYear: Int,
+    defaultBranch: String,
     contributorsUrl: URL,
     collaboratorsUrl: URL,
     releasesUrl: URL,
@@ -166,6 +167,7 @@ object Repository {
       license         <- json.get[License]("license")
       url             <- json.get[URL]("html_url")
       startYear       <- json.get[ZonedDateTime]("created_at")
+      defaultBranch   <- json.get[String]("default_branch")
       contributors    <- json.get[URL]("contributors_url")
       collaborators   <- json.get[URL]("collaborators_url")
       organizationUrl <- json.get[Option[URL]]("organization", "url")
@@ -177,6 +179,7 @@ object Repository {
       license,
       url,
       startYear.getYear,
+      defaultBranch,
       contributors,
       sbt.url(s"$collaborators".replace("{/collaborator}", "")),
       sbt.url(s"$releases".replace("{/id}", "")),
diff --git a/modules/sbt-github/src/main/scala/com/alejandrohdezma/sbt/github/syntax/url.scala b/modules/sbt-github/src/main/scala/com/alejandrohdezma/sbt/github/syntax/url.scala
@@ -25,7 +25,7 @@ object url {
 
     /** Adds a query param with the given `key`/`value` pair to this `URL` ad returns it. */
     def withQueryParam(key: String, value: String): URL = {
-      val uri = url.toURI // scalafix:ok Disable.URL
+      val uri = url.toURI
 
       val query = Option(uri.getQuery)
         .map(_ + s"&$key=$value")
diff --git a/modules/sbt-github/src/sbt-test/sbt-github/excluded-contributors/github/repository.json b/modules/sbt-github/src/sbt-test/sbt-github/excluded-contributors/github/repository.json
@@ -2,6 +2,7 @@
   "name": "repo",
   "full_name": "user1/repo",
   "created_at": "2018-01-01T13:30:30Z",
+  "default_branch": "name",
   "owner": {
     "url": "{{base_directory}}/user1.json"
   },
diff --git a/modules/sbt-github/src/sbt-test/sbt-github/extra-collaborators/github/repository.json b/modules/sbt-github/src/sbt-test/sbt-github/extra-collaborators/github/repository.json
@@ -5,6 +5,7 @@
   "owner": {
     "url": "{{base_directory}}/user1.json"
   },
+  "default_branch": "name",
   "html_url": "https://github.com/user1/repo",
   "description": "An awesome description",
   "collaborators_url": "{{base_directory}}/collaborators.json",
diff --git a/modules/sbt-github/src/sbt-test/sbt-github/not-use-owner/github/repository.json b/modules/sbt-github/src/sbt-test/sbt-github/not-use-owner/github/repository.json
@@ -5,6 +5,7 @@
   "owner": {
     "url": "{{base_directory}}/user1.json"
   },
+  "default_branch": "name",
   "html_url": "https://github.com/user1/repo",
   "description": "An awesome description",
   "collaborators_url": "{{base_directory}}/collaborators.json",
diff --git a/modules/sbt-github/src/sbt-test/sbt-github/override-organization/github/repository.json b/modules/sbt-github/src/sbt-test/sbt-github/override-organization/github/repository.json
@@ -5,6 +5,7 @@
   "owner": {
     "url": "{{base_directory}}/user1.json"
   },
+  "default_branch": "name",
   "html_url": "https://github.com/user1/repo",
   "description": "An awesome description",
   "collaborators_url": "{{base_directory}}/collaborators.json",
diff --git a/modules/sbt-github/src/sbt-test/sbt-github/simple/github/repository.json b/modules/sbt-github/src/sbt-test/sbt-github/simple/github/repository.json
@@ -6,6 +6,7 @@
     "url": "{{base_directory}}/user1.json"
   },
   "html_url": "https://github.com/user1/repo",
+  "default_branch": "name",
   "description": "An awesome description",
   "collaborators_url": "{{base_directory}}/collaborators.json",
   "contributors_url": "{{base_directory}}/contributors.json",
diff --git a/modules/sbt-github/src/test/scala/com/alejandrohdezma/sbt/github/github/repository/RepositorySuite.scala b/modules/sbt-github/src/test/scala/com/alejandrohdezma/sbt/github/github/repository/RepositorySuite.scala
@@ -36,6 +36,7 @@ class RepositorySuite extends munit.FunSuite {
             "description": "The description",
             "html_url": "http://example.com/repository",
             "created_at": "2011-01-26T19:01:12Z",
+            "default_branch": "main",
             "contributors_url": "http://api.github.com/repos/example/example/contributors",
             "collaborators_url": "http://api.github.com/repos/example/example/collaborators",
             "releases_url": "http://api.github.com/repos/example/example/releases",
@@ -56,16 +57,17 @@ class RepositorySuite extends munit.FunSuite {
       val repository = Repository.get("user", "repo")
 
       val expected = Repository(
-        "user/repo",
-        "The description",
-        License("id", url"http://example.com"),
-        url"http://example.com/repository",
-        2011,
-        url"http://api.github.com/repos/example/example/contributors",
-        url"http://api.github.com/repos/example/example/collaborators",
-        url"http://api.github.com/repos/example/example/releases",
-        Some(url"http://api.github.com/users/example"),
-        url"http://api.github.com/users/owner"
+        name = "user/repo",
+        description = "The description",
+        license = License("id", url"http://example.com"),
+        url = url"http://example.com/repository",
+        startYear = 2011,
+        defaultBranch = "main",
+        contributorsUrl = url"http://api.github.com/repos/example/example/contributors",
+        collaboratorsUrl = url"http://api.github.com/repos/example/example/collaborators",
+        releasesUrl = url"http://api.github.com/repos/example/example/releases",
+        organizationUrl = Some(url"http://api.github.com/users/example"),
+        ownerUrl = url"http://api.github.com/users/owner"
       )
 
       assertEquals(repository, Success(expected))
@@ -81,6 +83,7 @@ class RepositorySuite extends munit.FunSuite {
             "description": "The description",
             "html_url": "http://example.com/repository",
             "created_at": "2011-01-26T19:01:12Z",
+            "default_branch": "main",
             "contributors_url": "http://api.github.com/repos/example/example/contributors",
             "collaborators_url": "http://api.github.com/repos/example/example/collaborators",
             "releases_url": "http://api.github.com/repos/example/example/releases",
@@ -98,16 +101,17 @@ class RepositorySuite extends munit.FunSuite {
       val repository = Repository.get("user", "repo")
 
       val expected = Repository(
-        "user/repo",
-        "The description",
-        License("id", url"http://example.com"),
-        url"http://example.com/repository",
-        2011,
-        url"http://api.github.com/repos/example/example/contributors",
-        url"http://api.github.com/repos/example/example/collaborators",
-        url"http://api.github.com/repos/example/example/releases",
-        None,
-        url"http://api.github.com/users/owner"
+        name = "user/repo",
+        description = "The description",
+        license = License("id", url"http://example.com"),
+        url = url"http://example.com/repository",
+        startYear = 2011,
+        defaultBranch = "main",
+        contributorsUrl = url"http://api.github.com/repos/example/example/contributors",
+        collaboratorsUrl = url"http://api.github.com/repos/example/example/collaborators",
+        releasesUrl = url"http://api.github.com/repos/example/example/releases",
+        organizationUrl = None,
+        ownerUrl = url"http://api.github.com/users/owner"
       )
 
       assertEquals(repository, Success(expected))
diff --git a/modules/sbt-github/src/test/scala/com/alejandrohdezma/sbt/github/github/repository/package.scala b/modules/sbt-github/src/test/scala/com/alejandrohdezma/sbt/github/github/repository/package.scala
@@ -35,6 +35,7 @@ package object repository {
       License("", url"http://example.com"),
       url"http://example.com",
       0,
+      "main",
       url"http://example.com",
       url"http://example.com",
       url"http://example.com",
diff --git a/modules/sbt-github/src/test/scala/com/alejandrohdezma/sbt/github/http/ClientSuite.scala b/modules/sbt-github/src/test/scala/com/alejandrohdezma/sbt/github/http/ClientSuite.scala
@@ -32,7 +32,6 @@ import com.alejandrohdezma.sbt.github.syntax.json.JsonValueOps
 import org.http4s.dsl.io._
 import org.http4s.headers.Authorization
 
-@SuppressWarnings(Array("scalafix:Disable.blocking.io"))
 class ClientSuite extends munit.FunSuite {
 
   test("client.get should make `GET` call using auth and returning content as `A`") {
diff --git a/site/docs/sbt-mdoc.md b/site/docs/sbt-mdoc.md
@@ -24,6 +24,7 @@ The plugin provides the following `mdocVariables`:
 | **ORG_EMAIL**           | Set to the value of `organizationEmail` setting (Github's organization email, or owner's in case organization is empty and `populateOrganizationWithOwner` is `true`)      |
 | **ORG_URL**             | Set to the value of `organizationHomepage` setting (Github's organization homepage or owner's in case organization is empty and `populateOrganizationWithOwner` is `true`) |
 | **REPO**                | Set to the repository's path: "owner/repo"                                                                                                                                 |
+| **DEFAULT_BRANCH**                | Set to the repository's default branch                                                                                                                                 |
 | **START_YEAR**          | Set to the value of the `startYear` setting                                                                                                                                |
 | **YEAR_RANGE**          | Set to the value of the `yearRange` setting                                                                                                                                |
 | **COPYRIGHT_OWNER**     | Set to the value of `ORG_NAME <ORG_URL>` if `ORG_URL` is present or just `ORG_NAME` in case `ORG_URL` is empty                                                             |
