Updated docs

2017-03-08 10:54:31 +01:00
parent 761382f572
commit b34cbae3b5
6 changed files with 26 additions and 57 deletions
--- a/README.adoc
+++ b/README.adoc
@@ -3,9 +3,10 @@
 :jdkversion: 1.8
 :org: spring-cloud
 :repo: spring-cloud-release-tools
+:branch: master

-image::https://circleci.com/gh/{org}/{repo}/tree/1.1.x.svg?style=svg["CircleCI", link="https://circleci.com/gh/{org}/{repo}/tree/1.1.x"]
-image::https://codecov.io/gh/{org}/{repo}/branch/1.1.x/graph/badge.svg["codecov", link="https://codecov.io/gh/{org}/{repo}"]
+image::https://circleci.com/gh/{org}/{repo}/tree/{branch}.svg?style=svg["CircleCI", link="https://circleci.com/gh/{org}/{repo}/tree/{branch}"]
+image::https://codecov.io/gh/{org}/{repo}/branch/{branch}/graph/badge.svg["codecov", link="https://codecov.io/gh/{org}/{repo}"]
 image::https://badges.gitter.im/{org}/{repo}.svg[Gitter, link="https://gitter.im/{org}/{repo}?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge"]

 :github-tag: master
@@ -37,7 +38,7 @@ git clone https://github.com/spring-cloud/spring-cloud-sleuth
 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
+java -jar target/spring-cloud-release-tools-spring-1.0.0.M1.jar
 ----

 The application will start running from your working directory.
@@ -49,7 +50,7 @@ If you would like to use another branch you can specify it using the `releaser.b

 [source,bash]
 ----
-java -jar ~target/spring-cloud-release-tools-spring-1.0.0.M1.jar --Dreleaser.branch=Camden.SR6
+java -jar target/spring-cloud-release-tools-spring-1.0.0.M1.jar --Dreleaser.branch=Camden.SR6
 ----

 == Future plans
--- a/docs/pom.xml
+++ b/docs/pom.xml
@@ -12,8 +12,19 @@
 	<properties>
 		<docs.main>spring-cloud-release-tools</docs.main>
 		<main.basedir>${basedir}/..</main.basedir>
-		<build.plugins.plugin.version>2.19.1</build.plugins.plugin.version>
+		<maven.plugin.plugin.version>3.4</maven.plugin.plugin.version>
 	</properties>
+	<build>
+		<plugins>
+			<plugin>
+				<artifactId>maven-deploy-plugin</artifactId>
+				<version>2.8.2</version>
+				<configuration>
+					<skip>true</skip>
+				</configuration>
+			</plugin>
+		</plugins>
+	</build>
 	<profiles>
 		<profile>
 			<id>docs</id>
@@ -22,8 +33,14 @@
 					<plugin>
 						<groupId>org.asciidoctor</groupId>
 						<artifactId>asciidoctor-maven-plugin</artifactId>
-						<version>1.5.3</version>
 						<inherited>false</inherited>
+						<dependencies>
+							<dependency>
+								<groupId>io.spring.asciidoctor</groupId>
+								<artifactId>spring-asciidoctor-extensions</artifactId>
+								<version>0.1.0.BUILD-SNAPSHOT</version>
+							</dependency>
+						</dependencies>
 					</plugin>
 					<plugin>
 						<groupId>org.apache.maven.plugins</groupId>
--- a/docs/src/main/asciidoc/spring-cloud-release-tools.adoc
+++ b/docs/src/main/asciidoc/spring-cloud-release-tools.adoc
@@ -8,8 +8,7 @@
 :toclevels: 8
 :nofooter:

-Spring Cloud Release Tools
-====================
+# Spring Cloud Release Tools

 This project can be used to

@@ -27,7 +26,7 @@ git clone https://github.com/spring-cloud/spring-cloud-sleuth
 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
+java -jar target/spring-cloud-release-tools-spring-1.0.0.M1.jar
 ----

 The application will start running from your working directory.
@@ -43,7 +42,6 @@ java -jar target/spring-cloud-release-tools-spring-1.0.0.M1.jar --Dreleaser.bran
 ----

 == Future plans
-
 In the future it can also:

 - commit the changed values
--- a/pom.xml
+++ b/pom.xml
@@ -23,49 +23,4 @@
 		<module>spring-cloud-release-tools-spring</module>
 	</modules>

-	<profiles>
-		<profile>
-			<id>sonar</id>
-			<build>
-				<plugins>
-					<plugin>
-						<groupId>org.jacoco</groupId>
-						<artifactId>jacoco-maven-plugin</artifactId>
-						<executions>
-							<execution>
-								<id>pre-unit-test</id>
-								<goals>
-									<goal>prepare-agent</goal>
-								</goals>
-								<configuration>
-									<propertyName>surefireArgLine</propertyName>
-									<destFile>${project.build.directory}/jacoco.exec</destFile>
-								</configuration>
-							</execution>
-							<execution>
-								<id>post-unit-test</id>
-								<phase>test</phase>
-								<goals>
-									<goal>report</goal>
-								</goals>
-								<configuration>
-									<!-- Sets the path to the file which contains the execution data. -->
-									<dataFile>${project.build.directory}/jacoco.exec</dataFile>
-								</configuration>
-							</execution>
-						</executions>
-					</plugin>
-					<plugin>
-						<groupId>org.apache.maven.plugins</groupId>
-						<artifactId>maven-surefire-plugin</artifactId>
-						<configuration>
-							<!-- Sets the VM argument line used when unit tests are run. -->
-							<argLine>${surefireArgLine}</argLine>
-						</configuration>
-					</plugin>
-				</plugins>
-			</build>
-		</profile>
-	</profiles>
-
 </project>
--- a/spring-cloud-release-tools-core/pom.xml
+++ b/spring-cloud-release-tools-core/pom.xml
@@ -20,7 +20,6 @@
 	<properties>
 		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 		<java.version>1.8</java.version>
-		<build.plugins.plugin.version>2.19.1</build.plugins.plugin.version>
 	</properties>

 	<dependencies>
--- a/spring-cloud-release-tools-spring/pom.xml
+++ b/spring-cloud-release-tools-spring/pom.xml
@@ -20,7 +20,6 @@
 	<properties>
 		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 		<java.version>1.8</java.version>
-		<build.plugins.plugin.version>2.19.1</build.plugins.plugin.version>
 	</properties>

 	<dependencies>