remove extra badge info input key. (#84)

zio · Jan 6, 2023 · f68f385 · f68f385
1 parent 341a317
commit f68f385
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 48 deletions.
diff --git a/README.md b/README.md
@@ -6,14 +6,14 @@
 
 _ZIO SBT_ is an sbt plugin for ZIO projects. It provides high-level SBT utilities that simplify the development of ZIO applications.
 
-[![Production Ready](https://img.shields.io/badge/Project%20Stage-Production%20Ready-brightgreen.svg)](https://github.com/zio/zio/wiki/Project-Stages) ![CI Badge](https://github.com/zio/zio-sbt/workflows/CI/badge.svg) [![Sonatype Releases](https://img.shields.io/nexus/r/https/oss.sonatype.org/dev.zio/zio-sbt-website_2.12.svg?label=Sonatype%20Release)](https://oss.sonatype.org/content/repositories/releases/dev/zio/zio-sbt-website_2.12/) [![Sonatype Snapshots](https://img.shields.io/nexus/s/https/oss.sonatype.org/dev.zio/zio-sbt-website_2.12.svg?label=Sonatype%20Snapshot)](https://oss.sonatype.org/content/repositories/snapshots/dev/zio/zio-sbt-website_2.12/) [![javadoc](https://javadoc.io/badge2/dev.zio/zio-sbt-docs_2.13/javadoc.svg)](https://javadoc.io/doc/dev.zio/zio-sbt-docs_2.13) [![ZIO SBT](https://img.shields.io/github/stars/zio/zio-sbt?style=social)](https://github.com/zio/zio-sbt)
+[![Production Ready](https://img.shields.io/badge/Project%20Stage-Production%20Ready-brightgreen.svg)](https://github.com/zio/zio/wiki/Project-Stages) ![CI Badge](https://github.com/zio/zio-sbt/workflows/CI/badge.svg) [![Sonatype Releases](https://img.shields.io/nexus/r/https/oss.sonatype.org/dev.zio/zio-sbt-website_2.13.svg?label=Sonatype%20Release)](https://oss.sonatype.org/content/repositories/releases/dev/zio/zio-sbt-website_2.13/) [![Sonatype Snapshots](https://img.shields.io/nexus/s/https/oss.sonatype.org/dev.zio/zio-sbt-website_2.13.svg?label=Sonatype%20Snapshot)](https://oss.sonatype.org/content/repositories/snapshots/dev/zio/zio-sbt-website_2.13/) [![javadoc](https://javadoc.io/badge2/dev.zio/zio-sbt-docs_2.13/javadoc.svg)](https://javadoc.io/doc/dev.zio/zio-sbt-docs_2.13) [![ZIO SBT](https://img.shields.io/github/stars/zio/zio-sbt?style=social)](https://github.com/zio/zio-sbt)
 
 ## Installation
 
 Add the following lines to your `plugin.sbt` file:
 
 ```scala
-addSbtPlugin("dev.zio" % "zio-sbt-website" % "0.2.6")
+addSbtPlugin("dev.zio" % "zio-sbt-website" % "0.2.7")
 ```
 
 Then you can enable it by using the following code in your `build.sbt` file:

diff --git a/build.sbt b/build.sbt
@@ -100,13 +100,9 @@ lazy val docs = project
     moduleName     := "zio-sbt-docs",
     scalacOptions -= "-Yno-imports",
     scalacOptions -= "-Xfatal-warnings",
-    projectName := "ZIO SBT",
-    badgeInfo := Some(
-      BadgeInfo(
-        artifact = "zio-sbt-website_2.12",
-        projectStage = ProjectStage.ProductionReady
-      )
-    ),
+    projectName    := "ZIO SBT",
+    mainModuleName := (zioSbtWebsite / moduleName).value,
+    projectStage   := ProjectStage.ProductionReady,
     readmeContribution := readmeContribution.value +
       """|
          |#### TL;DR

diff --git a/zio-sbt-website/src/main/scala/zio/sbt/WebsitePlugin.scala b/zio-sbt-website/src/main/scala/zio/sbt/WebsitePlugin.scala
@@ -25,12 +25,7 @@ import mdoc.MdocPlugin.autoImport.*
 import sbt.Keys.*
 import sbt.{Def, *}
 
-import zio.sbt.WebsiteUtils.{ProjectStage, readFile, removeYamlHeader}
-
-case class BadgeInfo(
-  artifact: String,
-  projectStage: ProjectStage
-)
+import zio.sbt.WebsiteUtils.{readFile, removeYamlHeader}
 
 object WebsitePlugin extends sbt.AutoPlugin {
 
@@ -49,24 +44,21 @@ object WebsitePlugin extends sbt.AutoPlugin {
     val docsDependencies: SettingKey[Seq[ModuleID]] = settingKey[Seq[ModuleID]]("documentation project dependencies")
     val websiteDir: SettingKey[Path]                = settingKey[Path]("Website directory")
     val docsPublishBranch: SettingKey[String]       = settingKey[String]("Publish branch for documentation")
-    val badgeInfo: SettingKey[Option[BadgeInfo]] =
-      settingKey[Option[BadgeInfo]]("Information necessary to create badge")
-    val projectName: SettingKey[String]            = settingKey[String]("Project name e.g. ZIO SBT")
-    val projectHomePage: SettingKey[String]        = settingKey[String]("Project home page url e.g. https://zio.dev/zio-sbt")
-    val readmeBanner: SettingKey[String]           = settingKey[String]("Readme banner section")
-    val readmeDocumentation: SettingKey[String]    = settingKey[String]("Readme documentation section")
-    val readmeContribution: SettingKey[String]     = settingKey[String]("Readme contribution section")
-    val readmeCodeOfConduct: SettingKey[String]    = settingKey[String]("Readme code of conduct")
-    val readmeSupport: SettingKey[String]          = settingKey[String]("Readme support section")
-    val readmeLicense: SettingKey[String]          = settingKey[String]("Readme license section")
-    val readmeAcknowledgement: SettingKey[String]  = settingKey[String]("Acknowledgement section")
-    val readmeCredits: SettingKey[String]          = settingKey[String]("Credits section")
-    val readmeMaintainers: SettingKey[String]      = settingKey[String]("Maintainers section")
-    val docsVersioning: SettingKey[DocsVersioning] = settingKey[DocsVersioning]("Docs versioning style")
-    val sbtBuildOptions: SettingKey[List[String]]  = settingKey[List[String]]("SBT build options")
-
-    val BadgeInfo = zio.sbt.BadgeInfo
-    type BadgeInfo = zio.sbt.BadgeInfo
+    val projectStage: SettingKey[ProjectStage]      = settingKey[ProjectStage]("Project stage")
+    val projectName: SettingKey[String]             = settingKey[String]("Project name e.g. ZIO SBT")
+    val mainModuleName: SettingKey[String]          = settingKey[String]("Main Module Name e.g. zio-sbt")
+    val projectHomePage: SettingKey[String]         = settingKey[String]("Project home page url e.g. https://zio.dev/zio-sbt")
+    val readmeBanner: SettingKey[String]            = settingKey[String]("Readme banner section")
+    val readmeDocumentation: SettingKey[String]     = settingKey[String]("Readme documentation section")
+    val readmeContribution: SettingKey[String]      = settingKey[String]("Readme contribution section")
+    val readmeCodeOfConduct: SettingKey[String]     = settingKey[String]("Readme code of conduct")
+    val readmeSupport: SettingKey[String]           = settingKey[String]("Readme support section")
+    val readmeLicense: SettingKey[String]           = settingKey[String]("Readme license section")
+    val readmeAcknowledgement: SettingKey[String]   = settingKey[String]("Acknowledgement section")
+    val readmeCredits: SettingKey[String]           = settingKey[String]("Credits section")
+    val readmeMaintainers: SettingKey[String]       = settingKey[String]("Maintainers section")
+    val docsVersioning: SettingKey[DocsVersioning]  = settingKey[DocsVersioning]("Docs versioning style")
+    val sbtBuildOptions: SettingKey[List[String]]   = settingKey[List[String]]("SBT build options")
 
     val ProjectStage = zio.sbt.WebsiteUtils.ProjectStage
     type ProjectStage = zio.sbt.WebsiteUtils.ProjectStage
@@ -93,7 +85,6 @@ object WebsitePlugin extends sbt.AutoPlugin {
       generateGithubWorkflow := generateGithubWorkflowTask.value,
       checkGithubWorkflow    := checkGithubWorkflowTask.value,
       generateReadme         := generateReadmeTask.value,
-      badgeInfo              := None,
       docsDependencies       := Seq.empty,
       libraryDependencies ++= docsDependencies.value,
       mdocVariables ++= {
@@ -102,20 +93,15 @@ object WebsitePlugin extends sbt.AutoPlugin {
           "RELEASE_VERSION"  -> WebsiteUtils.releaseVersion(sLog.value.warn(_)).getOrElse("NOT RELEASED YET"),
           "SNAPSHOT_VERSION" -> version.value,
           "PROJECT_BADGES" -> {
-            badgeInfo.value match {
-              case Some(badge) =>
-                WebsiteUtils.generateProjectBadges(
-                  projectStage = badge.projectStage,
-                  groupId = organization.value,
-                  artifactId = badge.artifact,
-                  docsArtifactId = moduleName.value + '_' + scalaBinaryVersion.value,
-                  githubUser = "zio",
-                  githubRepo =
-                    scmInfo.value.map(_.browseUrl.getPath.split('/').last).getOrElse("github repo not provided"),
-                  projectName = projectName.value
-                )
-              case None => ""
-            }
+            WebsiteUtils.generateProjectBadges(
+              projectStage = projectStage.value,
+              groupId = organization.value,
+              artifactId = mainModuleName.value + '_' + scalaBinaryVersion.value,
+              docsArtifactId = moduleName.value + '_' + scalaBinaryVersion.value,
+              githubUser = "zio",
+              githubRepo = scmInfo.value.map(_.browseUrl.getPath.split('/').last).getOrElse("github repo not provided"),
+              projectName = projectName.value
+            )
           }
         )
       },