Including the branch name in the version?

[lokkju]

Any chance of a simple option to enable including branch names other than master in the version string?

[dwijnand]

Is there much demand for this support out the box?

Without out the box support you can do this by customising the version string, as defined in https://github.com/dwijnand/sbt-dynver#custom-version-string.

[lokkju]

I think it's a pretty common use case, and standard in many build systems; it's could be included as part of build metadata with semver, at the end.

More bringing it up a discussion point; it'd be nice to see the branch name in the metadata, but after thinking about it, it's not required for version uniqueness.

[raboof]

I don't think it would be particularly useful to include this in the default version string, but it would be neat to offer a utility function to easily get the git branch for use in your custom version string

[dwijnand]

A utility function leads to utility function variants, overloads, default params, etc. I'd rather not. Do something like

scala> scala.util.Try(scala.sys.process.Process("git rev-parse --symbolic-full-name --abbrev-ref HEAD").!!).toOption.map(_.dropRight(1))
res0: Option[String] = Some(master)

[atais]

I had a similar need and I do not think the lib is missing anything. It's actually all there.

Here is my very simplified auto-versioning.

.settings(
    version := myVersion(dynverGitDescribeOutput.value),
    dynver ~= (_.replace('+', '-'))
)

def myVersion(out: Option[sbtdynver.GitDescribeOutput]): String = {
  val branchName = Process("git rev-parse --symbolic-full-name --abbrev-ref HEAD").!!.dropRight(1)
  out match {
    case Some(v) if branchName == "develop" =>
      s"${v.commitSuffix.distance}-${v.ref.value}"
    case Some(v) =>
      s"${v.commitSuffix.distance}-${v.ref.value}-${branchName}"
    case None =>
      "0-undefined"
  }
}

btw. I am still using 3.3.0 because 4.0.0 is too fancy for me.