Add configuration for the README file and regex pattern

build.sbt

@@ -66,6 +66,8 @@ releaseProcess := Seq[ReleaseStep](
   releaseStepCommandAndRemaining("^ scripted"),
   setReleaseVersion,
   commitReleaseVersion,
+  updateReadme,
+  commitReadme,
   tagRelease,
   releaseStepCommandAndRemaining("^ publishSigned"),
   releaseStepTask(bintrayRelease in `sbt-release`),

src/main/scala/ReleaseExtra.scala

@@ -1,12 +1,20 @@
 package sbtrelease
 
+import java.nio.charset.StandardCharsets
+import java.nio.file.Files
+
 import sbt._
 import sbt.Keys._
 import sbt.Package.ManifestAttributes
+
 import annotation.tailrec
 import ReleasePlugin.autoImport._
 import ReleaseKeys._
+import sbtrelease.ReleasePlugin.autoImport
 
+import scala.io.Source
+import scala.util.matching.Regex
+import scala.util.matching.Regex.{ Groups, Match }
 import sys.process.ProcessLogger
 
 object ReleaseStateTransformations {
@@ -213,42 +221,54 @@ object ReleaseStateTransformations {
 
   lazy val updateReadme: ReleaseStep = ReleaseStep(updateReadmeStep)
   private def updateReadmeStep(state: State): State = {
+    def replacer(newVersion: String)(m: Regex.Match): String = m match {
+      case Groups(oldVersion) ⇒
+        m.toString().replace(oldVersion, newVersion)
+      case Match(_) ⇒
+        newVersion
+      case _ ⇒
+        m.toString()
+    }
     val extracted = Project.extract(state)
-    val releaseVersion = extracted.get(version)
-    val base = extracted.get(baseDirectory)
-    val readmeFile = base / "README.md"
-
-    val versionRegex = """(\d{1,2}\.\d{1,2}\.\d{1,2})""".r
-    val updatedReadmeContent = versionRegex.replaceAllIn(
-      IO.read(readmeFile),
-      releaseVersion
-    )
-
-    IO.write(readmeFile, updatedReadmeContent)
+    extracted.get(autoImport.releaseReadmeFile) match {
+      case Some(readmeFile) ⇒
+        val releaseVersion = extracted.get(version)
+        val versionRegex   = extracted.get(autoImport.releaseReadmeVersionRegex)
+        val readme         = Source.fromFile(readmeFile).mkString
+        Files.write(
+          readmeFile.toPath,
+          versionRegex.replaceAllIn(readme, replacer(releaseVersion)(_)).getBytes(StandardCharsets.UTF_8)
+        )
+        vcs(state).add()
+      case None ⇒
+    }
     state
   }
 
   lazy val commitReadme: ReleaseStep = ReleaseStep(commitReadmeStep)
   private def commitReadmeStep(state: State): State = {
-    val log = toProcessLogger(state)
-    val base = vcs(state).baseDir
-    val sign = Project.extract(state).get(releaseVcsSign)
-    val readmeFile = base / "README.md"
-
-    val relativePath = IO
-      .relativize(base, readmeFile)
-      .getOrElse(
-        "Version file [%s] is outside of this VCS repository with base directory [%s]!" format (readmeFile, base)
-      )
-
-    vcs(state).add(relativePath) !! log
-    val vcsAddOutput = (vcs(state).status !!).trim
-    if (vcsAddOutput.isEmpty) {
-      state.log.info("README.md hasn't been changed.")
-    } else {
-      vcs(state).commit("Update release version in readme", sign) ! log
+    val extracted = Project.extract(state)
+    extracted.get(releaseReadmeFile) match {
+      case Some(readmeFile) ⇒
+        val log = toProcessLogger(state)
+        val base = vcs(state).baseDir
+        val sign = extracted.get(releaseVcsSign)
+
+        val relativePath = IO
+          .relativize(base, readmeFile)
+          .getOrElse(
+            "Version file [%s] is outside of this VCS repository with base directory [%s]!" format(readmeFile, base)
+          )
+
+        vcs(state).add(relativePath) !! log
+        val vcsAddOutput = (vcs(state).status !!).trim
+        if (vcsAddOutput.isEmpty) {
+          state.log.info("README.md hasn't been changed.")
+        } else {
+          vcs(state).commit("Update release version in readme", sign) ! log
+        }
+      case None ⇒
     }
-
     state
   }
 

src/main/scala/ReleasePlugin.scala

@@ -1,12 +1,15 @@
 package sbtrelease
 
 import java.io.Serializable
+import java.nio.file.Path
 
 import sbt._
 import Keys._
 import sbt.complete.DefaultParsers._
 import sbt.complete.Parser
 
+import scala.util.matching.Regex
+
 object ReleasePlugin extends AutoPlugin {
 
   object autoImport {
@@ -27,6 +30,9 @@ object ReleasePlugin extends AutoPlugin {
     val releaseVcs = settingKey[Option[Vcs]]("The VCS to use")
     val releasePublishArtifactsAction = taskKey[Unit]("The action that should be performed to publish artifacts")
 
+    val releaseReadmeFile = settingKey[Option[File]]("The path to the README file")
+    val releaseReadmeVersionRegex = settingKey[Regex]("Regex pattern to find version in the README file")
+
     lazy val ReleaseTransformations = sbtrelease.ReleaseStateTransformations
 
     case class ReleaseStep(action: State => State, check: State => State = identity, enableCrossBuild: Boolean = false)
@@ -236,13 +242,19 @@ object ReleasePlugin extends AutoPlugin {
 
     releaseIgnoreUntrackedFiles := false,
 
+    releaseReadmeFile := None,
+
+    releaseReadmeVersionRegex := """\%\s+\"(\d{1,2}\.\d{1,2}\.\d{1,2})\"""".r,
+
     releaseProcess := Seq[ReleaseStep](
       checkSnapshotDependencies,
       inquireVersions,
       runClean,
       runTest,
       setReleaseVersion,
       commitReleaseVersion,
+      updateReadme,
+      commitReadme,
       tagRelease,
       publishArtifacts,
       setNextVersion,

src/sbt-test/sbt-release/update-readme-with-regex/.gitignore

@@ -0,0 +1 @@
+target/

src/sbt-test/sbt-release/update-readme-with-regex/README.md

@@ -0,0 +1,5 @@
+# Update README test
+
+```scala
+libraryDependencies += "com.example" %% "test" % "0.0.1"
+```

src/sbt-test/sbt-release/update-readme-with-regex/build.sbt

@@ -0,0 +1,36 @@
+import scala.io.Source
+import sbtrelease.ReleaseStateTransformations._
+
+releaseReadmeFile := Some(baseDirectory.value / "README.md")
+releaseReadmeVersionRegex := """\d{1,2}\.\d{1,2}\.\d{1,2}""".r
+
+releaseProcess := Seq(
+  inquireVersions,
+  runClean,
+  setReleaseVersion,
+  updateReadme,
+  commitReadme
+)
+
+TaskKey[Unit]("runTest") := {
+  val readmeFile = releaseReadmeFile.value.get
+  val expected =
+    """# Update README test
+      |
+      |```scala
+      |libraryDependencies += "com.example" %% "test" % "1.0.0"
+      |```""".stripMargin
+  val actual = Source.fromFile(readmeFile).mkString
+
+  val delimeter = "=" * 10
+
+  assert(
+    actual == expected,
+    s"""Unexpected README content after release:
+    |$delimeter expected $delimeter
+    |$expected
+    |$delimeter actual $delimeter
+    |$actual
+    |${delimeter * 2}""".stripMargin
+  )
+}

src/sbt-test/sbt-release/update-readme-with-regex/project/build.sbt

@@ -0,0 +1,7 @@
+{
+  val pluginVersion = System.getProperty("plugin.version")
+  if(pluginVersion == null)
+    throw new RuntimeException("""|The system property 'plugin.version' is not defined.
+                                  |Specify this property using the scriptedLaunchOpts -D.""".stripMargin)
+  else addSbtPlugin("com.github.gseitz" % "sbt-release" % pluginVersion)
+}

src/sbt-test/sbt-release/update-readme-with-regex/test

@@ -0,0 +1,9 @@
+$ exec git init .
+
+> update
+
+$ exec git add .
+$ exec git commit -m init
+
+> release release-version 1.0.0 next-version 1.0.1-SNAPSHOT
+> runTest

src/sbt-test/sbt-release/update-readme-with-regex/version.sbt

@@ -0,0 +1 @@
+version in ThisBuild := "1.9.0"

src/sbt-test/sbt-release/update-readme/.gitignore

@@ -1,2 +1 @@
-target
-global/
+target/

src/sbt-test/sbt-release/update-readme/README.md

@@ -1,7 +1,7 @@
-# A project
+# Update README test
 
-Add library in your `build.sbt`
+Casual version mentioning 0.0.1
 
 ```scala
-libraryDependencies += "com.example" %% "lib" % "1.0.0"
-```
+libraryDependencies += "com.example" %% "test" % "0.0.1"
+```

src/sbt-test/sbt-release/update-readme/build.sbt

@@ -1,32 +1,37 @@
+import scala.io.Source
 import sbtrelease.ReleaseStateTransformations._
 
+releaseReadmeFile := Some(baseDirectory.value / "README.md")
 
 releaseProcess := Seq(
-  checkSnapshotDependencies,
   inquireVersions,
   runClean,
-  runTest,
   setReleaseVersion,
-  commitReleaseVersion,
-  tagRelease,
   updateReadme,
-  commitReadme,
-  setNextVersion,
-  commitNextVersion
+  commitReadme
 )
 
-TaskKey[Unit]("checkReadme") := {
-  val readmeFile = baseDirectory.value / "README.md"
-  val content = IO.read(readmeFile)
+TaskKey[Unit]("runTest") := {
+  val readmeFile = releaseReadmeFile.value.get
+  val expected =
+    """# Update README test
+      |
+      |Casual version mentioning 0.0.1
+      |
+      |```scala
+      |libraryDependencies += "com.example" %% "test" % "1.0.0"
+      |```""".stripMargin
+  val actual = Source.fromFile(readmeFile).mkString
 
-  assert(content ==
-    """|# A project
-       |
-       |Add library in your `build.sbt`
-       |
-       |```scala
-       |libraryDependencies += "com.example" %% "lib" % "2.3.4"
-       |```
-       |""".stripMargin, s"Readme wasn't updated correctly\n\n$content")
+  val delimeter = "=" * 10
 
-}
+  assert(
+    actual == expected,
+    s"""Unexpected README content after release:
+    |$delimeter expected $delimeter
+    |$expected
+    |$delimeter actual $delimeter
+    |$actual
+    |${delimeter * 2}""".stripMargin
+  )
+}

src/sbt-test/sbt-release/update-readme/test

@@ -5,6 +5,5 @@ $ exec git init .
 $ exec git add .
 $ exec git commit -m init
 
-> release release-version 2.3.4 next-version 2.3.5-SNAPSHOT
-
-> checkReadme
+> release release-version 1.0.0 next-version 1.0.1-SNAPSHOT
+> runTest

src/sbt-test/sbt-release/update-readme/version.sbt

@@ -1 +1 @@
-version in ThisBuild := "1.0.0"
+version in ThisBuild := "1.9.0"