Packages

object ReleaseVersion

Convenient methods to integrate with the plugin sbt-release

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ReleaseVersion
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def fromAggregatedAssessedCompatibilityWithLatestRelease(qualifier: String = ...): sbt.Def.Initialize[Task[(String) ⇒ String]]

    Task returning a [release version function](https://github.com/sbt/sbt-release?tab=readme-ov-file#custom-versioning) based on the assessed compatibility level of the project (ie, the highest level of compatibility satisfied by all the sub-projects aggregated by this project).

    Task returning a [release version function](https://github.com/sbt/sbt-release?tab=readme-ov-file#custom-versioning) based on the assessed compatibility level of the project (ie, the highest level of compatibility satisfied by all the sub-projects aggregated by this project).

    Use it in the root project of your .sbt build definition as follows:

    import sbtversionpolicy.withsbtrelease.ReleaseVersion

val `my-project` =
  project
    .in(file("."))
    .aggregate(mySubproject1, mySubproject2)
    .settings(
      releaseVersion := ReleaseVersion.fromAggregatedAssessedCompatibilityWithLatestRelease().value
    )

    sbt-release uses the releaseVersion function to set the version before publishing a release (at step setReleaseVersion). It reads the current version (usually defined in a file version.sbt, and looking like "1.2.3-SNAPSHOT"), and applies the function to it.

    qualifier

    Optional qualifier to append to the version (e.g. "-RC1"). By default, it tries to read it from the environment variable VERSION_POLICY_RELEASE_QUALIFIER.

  9. def fromAssessedCompatibilityWithLatestRelease(qualifier: String = ...): sbt.Def.Initialize[Task[(String) ⇒ String]]

    Task returning a [release version function](https://github.com/sbt/sbt-release?tab=readme-ov-file#custom-versioning) based on the assessed compatibility level of the project.

    Task returning a [release version function](https://github.com/sbt/sbt-release?tab=readme-ov-file#custom-versioning) based on the assessed compatibility level of the project.

    Use it in your .sbt build definition as follows:

    import sbtversionpolicy.withsbtrelease.ReleaseVersion

releaseVersion := ReleaseVersion.fromAssessedCompatibilityWithLatestRelease().value

    sbt-release uses the releaseVersion function to set the version before publishing a release (at step setReleaseVersion). It reads the current version (usually defined in a file version.sbt, and looking like "1.2.3-SNAPSHOT"), and applies the function to it.

    qualifier

    Optional qualifier to append to the version (e.g. "-RC1"). By default, it tries to read it from the environment variable VERSION_POLICY_RELEASE_QUALIFIER.

  10. def fromCompatibility(compatibility: Compatibility, qualifier: String = ...): (String) ⇒ String

    qualifier

    Optional qualifier to append to the version (e.g. "-RC1"). By default, it tries to read it from the environment variable VERSION_POLICY_RELEASE_QUALIFIER.

    returns

    a [release version function](https://github.com/sbt/sbt-release?tab=readme-ov-file#custom-versioning) that bumps the patch, minor, or major version number depending on the provided compatibility level.

  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    AnyRef → Any
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped