diff --git a/README.adoc b/README.adoc index afcd8727..742f04f8 100644 --- a/README.adoc +++ b/README.adoc @@ -45,15 +45,17 @@ Go to your project (e.g. Spring Cloud Sleuth) [source,bash] ---- -$ git clone https://github.com/spring-cloud/spring-cloud-sleuth +$ git clone git@github.com:spring-cloud/spring-cloud-sleuth.git $ cd spring-cloud-sleuth -$ mkdir -p target -$ wget http://repo.spring.io/libs-milestone/org/springframework/cloud/internal/spring-cloud-release-tools-spring/1.0.0.M1/spring-cloud-release-tools-spring-1.0.0.M1.jar -O target/spring-cloud-release-tools-spring-1.0.0.M1.jar -$ java -jar target/spring-cloud-release-tools-spring-1.0.0.M1.jar +$ wget http://repo.spring.io/libs-milestone/org/springframework/cloud/internal/spring-cloud-release-tools-spring/1.0.0.M1/spring-cloud-release-tools-spring-1.0.0.M1.jar -O spring-cloud-release-tools-spring-1.0.0.M1.jar +$ java -jar spring-cloud-release-tools-spring-1.0.0.M1.jar ---- The application will start running from your working directory. +TIP: It is important that you clone the repository you are going to release using SSH in order for the +`releaser` to be able to push tags and commit changes automatically. + === Project options - `releaser.git.clone-destination-dir` - Where should the Spring Cloud Release repo get cloned to. If null defaults to a temporary directory @@ -94,7 +96,22 @@ If you would like to use another branch you can specify it using the `releaser.p [source,bash] ---- -$ java -jar target/spring-cloud-release-tools-spring-1.0.0.M1.jar --releaser.pom.branch=Camden.SR6 +$ java -jar spring-cloud-release-tools-spring-1.0.0.M1.jar --releaser.pom.branch=Camden.SR6 +---- + +==== Using Environment Variables + +In some cases it might be easier to specify environment variables instead of passing parameters to +`releaser`. For example, you might want to use environment variables if you are going to be +releasing multiple projects, this keeps you from having to specify the same parameters for +each release + +[source,bash] +---- +$ export RELEASER_POM_BRANCH=Dalston.RELEASE +$ export RELEASER_GIT_OAUTH_TOKEN=... +$ wget http://repo.spring.io/libs-milestone/org/springframework/cloud/internal/spring-cloud-release-tools-spring/1.0.0.M1/spring-cloud-release-tools-spring-1.0.0.M1.jar -O spring-cloud-release-tools-spring-1.0.0.M1.jar +$ java -jar target/spring-cloud-release-tools-spring-1.0.0.M1.jar --releaser.working-dir=/path/to/project/root ---- == Building diff --git a/docs/src/main/asciidoc/spring-cloud-release-tools.adoc b/docs/src/main/asciidoc/spring-cloud-release-tools.adoc index 76b166f8..55265f23 100644 --- a/docs/src/main/asciidoc/spring-cloud-release-tools.adoc +++ b/docs/src/main/asciidoc/spring-cloud-release-tools.adoc @@ -35,15 +35,17 @@ Go to your project (e.g. Spring Cloud Sleuth) [source,bash] ---- -$ git clone https://github.com/spring-cloud/spring-cloud-sleuth +$ git clone git@github.com:spring-cloud/spring-cloud-sleuth.git $ cd spring-cloud-sleuth -$ mkdir -p target -$ wget http://repo.spring.io/libs-milestone/org/springframework/cloud/internal/spring-cloud-release-tools-spring/1.0.0.M1/spring-cloud-release-tools-spring-1.0.0.M1.jar -O target/spring-cloud-release-tools-spring-1.0.0.M1.jar -$ java -jar target/spring-cloud-release-tools-spring-1.0.0.M1.jar +$ wget http://repo.spring.io/libs-milestone/org/springframework/cloud/internal/spring-cloud-release-tools-spring/1.0.0.M1/spring-cloud-release-tools-spring-1.0.0.M1.jar -O spring-cloud-release-tools-spring-1.0.0.M1.jar +$ java -jar spring-cloud-release-tools-spring-1.0.0.M1.jar ---- The application will start running from your working directory. +TIP: It is important that you clone the repository you are going to release using SSH in order for the +`releaser` to be able to push tags and commit changes automatically. + === Project options - `releaser.git.clone-destination-dir` - Where should the Spring Cloud Release repo get cloned to. If null defaults to a temporary directory @@ -84,5 +86,20 @@ If you would like to use another branch you can specify it using the `releaser.p [source,bash] ---- -$ java -jar target/spring-cloud-release-tools-spring-1.0.0.M1.jar --releaser.pom.branch=Camden.SR6 +$ java -jar spring-cloud-release-tools-spring-1.0.0.M1.jar --releaser.pom.branch=Camden.SR6 ---- + +==== Using Environment Variables + +In some cases it might be easier to specify environment variables instead of passing parameters to +`releaser`. For example, you might want to use environment variables if you are going to be +releasing multiple projects, this keeps you from having to specify the same parameters for +each release + +[source,bash] +---- +$ export RELEASER_POM_BRANCH=Dalston.RELEASE +$ export RELEASER_GIT_OAUTH_TOKEN=... +$ wget http://repo.spring.io/libs-milestone/org/springframework/cloud/internal/spring-cloud-release-tools-spring/1.0.0.M1/spring-cloud-release-tools-spring-1.0.0.M1.jar -O spring-cloud-release-tools-spring-1.0.0.M1.jar +$ java -jar target/spring-cloud-release-tools-spring-1.0.0.M1.jar --releaser.working-dir=/path/to/project/root +---- \ No newline at end of file