sbt-release

# sbt-release
This sbt plugin provides a customizable release process that you can add to your project.

[![sbt-release sbt 1](https://index.scala-lang.org/sbt/sbt-release/sbt-release/latest-by-scala-version.svg?platform=sbt1)](https://index.scala-lang.org/sbt/sbt-release/sbt-release)
[![sbt-release sbt 2](https://index.scala-lang.org/sbt/sbt-release/sbt-release/latest-by-scala-version.svg?platform=sbt2)](https://index.scala-lang.org/sbt/sbt-release/sbt-release)

**Notice:** This README contains information for the latest release. Please refer to the documents for a specific version by looking up the respective [tag](https://github.com/sbt/sbt-release/tags).

## Requirements
 * sbt 1.x
 * The version of the project should follow the semantic versioning scheme on [semver.org](https://www.semver.org) with the following additions:
   * The minor and bugfix (and beyond) part of the version are optional.
   * There is no limit to the number of subversions you may have.
   * The appendix after the bugfix part must be alphanumeric (`[0-9a-zA-Z]`) but may also contain dash characters `-`.
   * These are all valid version numbers:
     * 1.2.3
     * 1.2.3-SNAPSHOT
     * 1.2beta1
     * 1.2-beta.1
     * 1.2
     * 1
     * 1-BETA17
     * 1.2.3.4.5
     * 1.2.3.4.5-SNAPSHOT
 * A [publish repository](https://www.scala-sbt.org/1.x/docs/Publishing.html) configured. (Required only for the default release process. See further below for release process customizations.)
 * git [optional]

## Usage

Add the following lines to `./project/plugins.sbt`. See the section [Using Plugins](https://www.scala-sbt.org/1.x/docs/Using-Plugins.html) in the sbt website for more information.

```scala
addSbtPlugin("com.github.sbt" % "sbt-release" % "1.5.0")
```

## version.sbt

Since the build definition is actual Scala code, it's not as straight forward to change something in the middle of it as it is with an XML definition.

For this reason, *sbt-release* won't ever touch your build definition files, but instead writes the new release or development version to a file defined by the setting `releaseVersionFile`, which is set to **`file("version.sbt")`** by default and points to `$PROJECT_ROOT/version.sbt`.

By default the version is set on the build level (using `ThisBuild / version`). This behavior can be controlled by setting `releaseUseGlobalVersion` to `false`, after which a version like `version := "1.2.3"` will be written to `version.sbt`.


## Release Process

The default release process consists of the following tasks:

 1. Check that the working directory is a git repository and the repository has no outstanding changes. Also prints the hash of the last commit to the console.
 1. If there are any snapshot dependencies, ask the user whether to continue or not (default: no).
 1. Ask the user for the `release version` and the `next development version`. Sensible defaults are provided.
 1. Run `clean`.
 1. Run `test`, if any test fails, the release process is aborted.
 1