1. Building and Deploying
To install locally:
$ mvn install -s .settings.xml
and to deploy snapshots to repo.spring.io:
$ mvn deploy -DaltSnapshotDeploymentRepository=repo.spring.io::default::https://repo.spring.io/libs-snapshot-local
for a RELEASE build use
$ mvn deploy -DaltReleaseDeploymentRepository=repo.spring.io::default::https://repo.spring.io/libs-release-local
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
$ mvn deploy -P central -DaltReleaseDeploymentRepository=sonatype-nexus-staging::default::https://oss.sonatype.org/service/local/staging/deploy/maven2
(the "central" profile is available for all projects in Spring Cloud and it sets up the gpg jar signing, and the repository has to be specified separately for this project because it is a parent of the starter parent which users in turn have as their own parent).
Spring Cloud is released under the non-restrictive Apache 2.0 license,
+and follows a very standard Github development process, using Github
+tracker for issues and merging pull requests into master. If you want
+to contribute even something trivial please do not hesitate, but
+follow the guidelines below.
2.1 Sign the Contributor License Agreement
Before we accept a non-trivial patch or pull request we will need you to sign the
+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
+given the ability to merge pull requests.
2.3 Code Conventions and Housekeeping
None of these is essential for a pull request, but they will all help. They can also be
+added after the original pull request but before a merge.
- Use the Spring Framework code format conventions. If you use Eclipse
+you can import formatter settings using the
+
eclipse-code-formatter.xml file from the
+Spring
+Cloud Build project. If using IntelliJ, you can use the
+Eclipse Code Formatter
+Plugin to import the same file. - Make sure all new
.java files to have a simple Javadoc class comment with at least an
+@author tag identifying you, and preferably at least a paragraph on what the class is
+for. - Add the ASF license header comment to all new
.java files (copy from existing files
+in the project) - Add yourself as an
@author to the .java files that you modify substantially (more
+than cosmetic changes). - Add some Javadocs and, if you change the namespace, some XSD doc elements.
- A few unit tests would help a lot as well — someone has to do it.
- If no-one else is using your branch, please rebase it against the current master (or
+other target branch in the main project).
- When writing a commit message please follow 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).
3. 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
<profiles>
+ <profile>
+ <id>docs</id>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-dependency-plugin</artifactId> 
+ </plugin>
+ <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> 
+ <inherited>false</inherited>
+ </plugin>
+ </plugins>
+ </build>
+ </profile>
+ </profiles>
| This plugin downloads and unpacks the resources of the spring-cloud-build-docs module |
| This plugin is required to parse the Asciidoctor documentation |
| This plugin converts the Asciidoctor documentation into single and multi page docs |
| This plugin is required to copy resources into proper final destinations and to generate main README.adoc |
![[Important]](images/important.png) | Important |
|---|
The order of plugin declaration is important! |