SpringCloud/spring-cloud-build
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'master' into 2.0.x

Browse Source
This commit is contained in:
Marcin Grzejszczak
2017-08-31 14:19:34 +02:00
parent fe8ac6ba05 8f19618cc2
commit 4e7df1097b
4 changed files with 106 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

55
README.adoc
View File

@@ -1,4 +1,6 @@
// Do not edit this file (e.g. go instead to docs/src/main/asciidoc)
// Do not edit this file (e.g. go instead to src/main/asciidoc)
image:https://circleci.com/gh/spring-cloud/spring-cloud-build.svg?style=svg[link="https://travis-ci.org/spring-cloud/spring-cloud-build"]
Spring Cloud Build is a common utility project for Spring Cloud
to use for plugin and dependency management.
@@ -26,9 +28,9 @@ $ mvn deploy -DaltReleaseDeploymentRepository=repo.spring.io::default::https://r
and for jcenter use
---
----
$ mvn deploy -DaltReleaseDeploymentRepository=bintray::default::https://api.bintray.com/maven/spring/jars/org.springframework.cloud:build
---
----
and for Maven Central use
@@ -48,7 +50,7 @@ follow the guidelines below.
=== Sign the Contributor License Agreement
Before we accept a non-trivial patch or pull request we will need you to sign the
https://support.springsource.com/spring_committer_signup[contributor's agreement].
https://cla.pivotal.io/sign/spring[Contributor License Agreement].
Signing the contributor's agreement does not grant anyone commit rights to the main
repository, but it does mean that we can accept your contributions, and you will get an
author credit if we do. Active contributors might be asked to join the core team, and
@@ -83,4 +85,47 @@ added after the original pull request but before a merge.
other target branch in the main project).
* When writing a commit message please follow http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html[these conventions],
if you are fixing an existing issue please add `Fixes gh-XXXX` at the end of the commit
message (where XXXX is the issue number).
message (where XXXX is the issue number).
== Reusing the documentation
Spring Cloud Build publishes its `spring-cloud-build-docs` module that contains
helpful scripts (e.g. README generation ruby script) and css, xslt and images
for the Spring Cloud documentation. If you want to follow the same convention
approach of generating documentation just add these plugins to your `docs` module
[source,xml]
----
<profiles>
<profile>
<id>docs</id>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-dependency-plugin</artifactId> <1>
</plugin>
<plugin>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-maven-plugin</artifactId> <2>
</plugin>
<plugin>
<groupId>com.agilejava.docbkx</groupId>
<artifactId>docbkx-maven-plugin</artifactId> <3>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-antrun-plugin</artifactId> <4>
<inherited>false</inherited>
</plugin>
</plugins>
</build>
</profile>
</profiles>
----
<1> This plugin downloads and unpacks the resources of the `spring-cloud-build-docs` module
<2> This plugin is required to parse the Asciidoctor documentation
<3> This plugin converts the Asciidoctor documentation into single and multi page docs
<4> This plugin is required to copy resources into proper final destinations and to generate main README.adoc
IMPORTANT: The order of plugin declaration is important!

28
docs/pom.xml
View File

@@ -11,6 +11,13 @@
<artifactId>spring-cloud-build</artifactId>
<version>2.0.0.BUILD-SNAPSHOT</version>
</parent>
<properties>
<docs.main>spring-cloud-build</docs.main>
<!-- Comma separated list of whitelisted branches -->
<docs.whitelisted.branches>1.2.x,2.0.x</docs.whitelisted.branches>
<main.basedir>${basedir}/..</main.basedir>
<docs.resources.dir>${basedir}/src/main</docs.resources.dir>
</properties>
<build>
<resources>
<resource>
@@ -24,4 +31,25 @@
</plugin>
</plugins>
</build>
<profiles>
<profile>
<id>docs</id>
<build>
<plugins>
<plugin>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-maven-plugin</artifactId>
</plugin>
<plugin>
<groupId>com.agilejava.docbkx</groupId>
<artifactId>docbkx-maven-plugin</artifactId>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-antrun-plugin</artifactId>
</plugin>
</plugins>
</build>
</profile>
</profiles>
</project>

2
docs/src/main/asciidoc/README.adoc
View File

@@ -82,3 +82,5 @@ approach of generating documentation just add these plugins to your `docs` modul
<2> This plugin is required to parse the Asciidoctor documentation
<3> This plugin converts the Asciidoctor documentation into single and multi page docs
<4> This plugin is required to copy resources into proper final destinations and to generate main README.adoc
IMPORTANT: The order of plugin declaration is important!

37
pom.xml
View File

@@ -27,14 +27,15 @@
<maven.compiler.target>${java.version}</maven.compiler.target>
<main.basedir>${basedir}</main.basedir>
<docs.main>${project.artifactId}</docs.main>
<spring-boot.version>2.0.0.M3</spring-boot.version>
<spring-cloud-build.version>2.0.0.BUILD-SNAPSHOT</spring-cloud-build.version>
<docs.resources.dir>${project.build.directory}/build-docs</docs.resources.dir>
<!-- Sonar -->
<sonar.java.coveragePlugin>jacoco</sonar.java.coveragePlugin>
<sonar.dynamicAnalysis>reuseReports</sonar.dynamicAnalysis>
<sonar.jacoco.reportPath>${project.basedir}/../target/jacoco.exec</sonar.jacoco.reportPath>
<sonar.language>java</sonar.language>
<spring-boot.version>2.0.0.M3</spring-boot.version>
</properties>
<dependencyManagement>
<dependencies>
@@ -459,6 +460,9 @@ limitations under the License.
<snapshots>
<enabled>true</enabled>
</snapshots>
<releases>
<enabled>false</enabled>
</releases>
</repository>
<repository>
<id>spring-milestones</id>
@@ -485,6 +489,9 @@ limitations under the License.
<snapshots>
<enabled>true</enabled>
</snapshots>
<releases>
<enabled>false</enabled>
</releases>
</pluginRepository>
<pluginRepository>
<id>spring-milestones</id>
@@ -494,6 +501,14 @@ limitations under the License.
<enabled>false</enabled>
</snapshots>
</pluginRepository>
<pluginRepository>
<id>spring-releases</id>
<name>Spring Releases</name>
<url>https://repo.spring.io/libs-release-local</url>
<snapshots>
<enabled>false</enabled>
</snapshots>
</pluginRepository>
</pluginRepositories>
</profile>
<profile>
@@ -659,7 +674,7 @@ limitations under the License.
<classifier>sources</classifier>
<type>jar</type>
<overWrite>false</overWrite>
<outputDirectory>${project.build.directory}/build-docs</outputDirectory>
<outputDirectory>${docs.resources.dir}</outputDirectory>
</artifactItem>
</artifactItems>
</configuration>
@@ -729,10 +744,10 @@ limitations under the License.
<includes>${docs.main}.xml</includes>
<xincludeSupported>true</xincludeSupported>
<chunkedOutput>false</chunkedOutput>
<foCustomization>${project.build.directory}/build-docs/docbook/xsl/pdf.xsl</foCustomization>
<foCustomization>${docs.resources.dir}/docbook/xsl/pdf.xsl</foCustomization>
<useExtensions>1</useExtensions>
<highlightSource>1</highlightSource>
<highlightXslthlConfig>${project.build.directory}/build-docs/docbook/xsl/xslthl-config.xml</highlightXslthlConfig>
<highlightXslthlConfig>${docs.resources.dir}/docbook/xsl/xslthl-config.xml</highlightXslthlConfig>
</configuration>
<dependencies>
<dependency>
@@ -757,7 +772,7 @@ limitations under the License.
</goals>
<phase>prepare-package</phase>
<configuration>
<htmlCustomization>${project.build.directory}/build-docs/docbook/xsl/html-singlepage.xsl</htmlCustomization>
<htmlCustomization>${docs.resources.dir}/docbook/xsl/html-singlepage.xsl</htmlCustomization>
<targetDirectory>${basedir}/target/docbook/htmlsingle</targetDirectory>
<postProcess>
<copy todir="${basedir}/target/contents/reference/htmlsingle">
@@ -766,7 +781,7 @@ limitations under the License.
</fileset>
</copy>
<copy todir="${basedir}/target/contents/reference/htmlsingle">
<fileset dir="${project.build.directory}/build-docs/docbook">
<fileset dir="${docs.resources.dir}/docbook">
<include name="**/*.css" />
<include name="**/*.png" />
<include name="**/*.gif" />
@@ -783,7 +798,7 @@ limitations under the License.
</goals>
<phase>prepare-package</phase>
<configuration>
<htmlCustomization>${project.build.directory}/build-docs/docbook/xsl/html-multipage.xsl</htmlCustomization>
<htmlCustomization>${docs.resources.dir}/docbook/xsl/html-multipage.xsl</htmlCustomization>
<targetDirectory>${basedir}/target/docbook/html</targetDirectory>
<!-- By default `-` prefix is added to files and gh-pages don't render these files -->
<chunkedFilenamePrefix>multi_</chunkedFilenamePrefix>
@@ -795,7 +810,7 @@ limitations under the License.
</fileset>
</copy>
<copy todir="${basedir}/target/contents/reference/html">
<fileset dir="${project.build.directory}/build-docs/docbook">
<fileset dir="${docs.resources.dir}/docbook">
<include name="**/*.css" />
<include name="**/*.png" />
<include name="**/*.gif" />
@@ -859,7 +874,7 @@ limitations under the License.
<configuration>
<target>
<java classname="org.jruby.Main" failonerror="yes">
<arg value="${project.build.directory}/build-docs/ruby/generate_readme.sh"/>
<arg value="${docs.resources.dir}/ruby/generate_readme.sh"/>
<arg value="-o"/>
<arg value="${main.basedir}/README.adoc"/>
</java>
@@ -875,10 +890,10 @@ limitations under the License.
<configuration>
<target>
<copy todir="${basedir}/target/generated-docs/css">
<fileset dir="${project.build.directory}/build-docs/docbook/css"/>
<fileset dir="${docs.resources.dir}/docbook/css"/>
</copy>
<copy failonerror="false" todir="${basedir}/target/generated-docs/images">
<fileset dir="${project.build.directory}/build-docs/docbook/images"/>
<fileset dir="${docs.resources.dir}/docbook/images"/>
</copy>
</target>
</configuration>