Skip to content

Commit 4852218

Browse files
armanbilgebplommer
andcommitted
Bikeshed setting names, descriptions
Co-authored-by: Ben Plommer <[email protected]>
1 parent c58d30b commit 4852218

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

versioning/src/main/scala/org/typelevel/sbt/TypelevelVersioningPlugin.scala

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,11 @@ object TypelevelVersioningPlugin extends AutoPlugin {
3939
settingKey[Boolean](
4040
"If true, an untagged commit is given a snapshot version, e.g. 0.4-00218f9-SNAPSHOT. If false, it is given a release version, e.g. 0.4-00218f9. (default: true)")
4141

42-
lazy val tlCurrentRelease =
43-
settingKey[Option[String]](
44-
"The latest stable released version of your project, e.g. 0.2.0, 3.5.1. If applicable, this will be the version currently being released.")
42+
lazy val tlLatestVersion = settingKey[Option[String]](
43+
"The latest tagged version that is binary-compatible with the version in this build. The latest stable version is given first priority, otherwise falls back to the latest pre-release version (e.g. milestones/release candidates). If applicable, this will be the current tagged version.")
4544

46-
lazy val tlCurrentPreRelease = settingKey[Option[String]](
47-
"The latest pre-release (e.g. milestone, release candidate) of your project. If applicable, this will be the version currently being released.")
45+
lazy val tlLatestPreReleaseVersion = settingKey[Option[String]](
46+
"The latest tagged version, including milestones and release candidates, that is binary-compatible with the version in this build. If applicable, this will be the current tagged version.")
4847
}
4948

5049
import autoImport._
@@ -132,8 +131,8 @@ object TypelevelVersioningPlugin extends AutoPlugin {
132131

133132
version
134133
},
135-
tlCurrentRelease := currentRelease.value,
136-
tlCurrentPreRelease := currentPreRelease.value
134+
tlLatestVersion := currentRelease.value,
135+
tlLatestPreReleaseVersion := currentPreRelease.value
137136
)
138137

139138
private val Description = """^.*-(\d+)-[a-zA-Z0-9]+$""".r

0 commit comments

Comments
 (0)