diff --git a/README.md b/README.md index 3b9de2f..a6eab25 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ Inspired by: Add this to your sbt build plugins, in either `project/plugins.sbt` or `project/dynver.sbt`: - addSbtPlugin("com.dwijnand" % "sbt-dynver" % "2.0.0-M0") + addSbtPlugin("com.dwijnand" % "sbt-dynver" % "2.0.0") Then make sure to **NOT set the version setting**, otherwise you will override `sbt-dynver`. diff --git a/notes/2.0.0.markdown b/notes/2.0.0.markdown index 0e35f2c..cc83753 100644 --- a/notes/2.0.0.markdown +++ b/notes/2.0.0.markdown @@ -1,11 +1,15 @@ -### Changes +### Breaking Changes -- Consider untagged but 'clean' repositories as 'snapshots'. +#### Change in `isSnapshot` - now only tagged versions are not snapshots -Previously, because dynver generates a unique, stable version for each commit from a -non-dirty repository, it set `isSnapshot` to `false` for all of these. This made sense -since these versions are stable, immutable identifiers that can be relied upon for example +Previously, because sbt-dynver generates a unique, stable version for each commit from a +non-dirty repository, it set `isSnapshot` to `false` for this case. This made sense +since these versions are stable, immutable identifiers that can be relied upon, for example, for caching, but did not correspond to the intuition of a 'snapshot' as an intermediate, non-released version. From version 2.0.0 onwards, `isSnapshot` will only be false for tagged releases, and the key `isVersionStable` can be used to determine whether the current version -is a stable identifier. +is a stable identifier, as well as a migration aid to sbt-dynve 2.x. [#23][]/[#42][] by [@raboof][] + +[#23]: https://github.com/dwijnand/sbt-dynver/issues/23 +[#42]: https://github.com/dwijnand/sbt-dynver/pull/42 +[@raboof]: https://github.com/raboof