From ab7a64fbd11bdf25fd5892061537f3276c16a8a3 Mon Sep 17 00:00:00 2001 From: Ryan Baxter Date: Tue, 7 Mar 2017 20:38:20 -0500 Subject: [PATCH] Documentation for specifying a branch --- README.adoc | 11 ++++++++++- .../src/main/asciidoc/spring-cloud-release-tools.adoc | 11 ++++++++++- 2 files changed, 20 insertions(+), 2 deletions(-) diff --git a/README.adoc b/README.adoc index 8e8cbbe2..b71e20e3 100644 --- a/README.adoc +++ b/README.adoc @@ -42,8 +42,17 @@ java -jar ~target/spring-cloud-release-tools-spring-1.0.0.M1.jar The application will start running from your working directory. -== Future plans +=== Specifying A Branch +By deafult the releaser will default to using the `master` branch of `spring-cloud-release`. +If you would like to use another branch you can specify it using the `releaser.branch` property. + +[source,bash] +---- +java -jar ~target/spring-cloud-release-tools-spring-1.0.0.M1.jar --Dreleaser.branch=Camden.SR6 +---- + +== Future plans In the future it can also: - commit the changed values diff --git a/docs/src/main/asciidoc/spring-cloud-release-tools.adoc b/docs/src/main/asciidoc/spring-cloud-release-tools.adoc index 848f0d03..de796238 100644 --- a/docs/src/main/asciidoc/spring-cloud-release-tools.adoc +++ b/docs/src/main/asciidoc/spring-cloud-release-tools.adoc @@ -32,8 +32,17 @@ java -jar ~target/spring-cloud-release-tools-spring-1.0.0.M1.jar The application will start running from your working directory. -== Future plans +=== Specifying A Branch +By deafult the releaser will default to using the `master` branch of `spring-cloud-release`. +If you would like to use another branch you can specify it using the `releaser.branch` property. + +[source,bash] +---- +java -jar ~target/spring-cloud-release-tools-spring-1.0.0.M1.jar --Dreleaser.branch=Camden.SR6 +---- + +== Future plans In the future it can also: - commit the changed values