|
|
|
|
@@ -1,4 +1,8 @@
|
|
|
|
|
// Do not edit this file (e.g. go instead to src/main/asciidoc)
|
|
|
|
|
////
|
|
|
|
|
DO NOT EDIT THIS FILE. IT WAS GENERATED.
|
|
|
|
|
Manual changes to this file will be lost when it is generated again.
|
|
|
|
|
Edit the files in the src/main/asciidoc/ directory instead.
|
|
|
|
|
////
|
|
|
|
|
|
|
|
|
|
:jdkversion: 1.8
|
|
|
|
|
:org: spring-cloud
|
|
|
|
|
@@ -300,12 +304,17 @@ The following properties are used for both meta release and a release of an indi
|
|
|
|
|
|
|
|
|
|
- `releaser.post-release-tasks-only` - If set to `true` will run only post release tasks. Defaults to `false`.
|
|
|
|
|
- `releaser.meta-release.release-train-project-name` - Name of the project that represents the BOM of the release train. Defaults to `spring-cloud-release`.
|
|
|
|
|
- `releaser.meta-release.release-train-dependency-names` - Names of the projects that should be updated with the version of the release train. Defaults to `[spring-cloud, spring-cloud-dependencies, spring-cloud-starter]`.
|
|
|
|
|
- `releaser.git.fetch-versions-from-git` - If `true` then should fill the map of versions from Git. If `false` then picks fixed versions.
|
|
|
|
|
- `releaser.git.clone-destination-dir` - Where should the Spring Cloud Release repo get cloned to. If null defaults to a temporary directory.
|
|
|
|
|
- `releaser.git.release-train-bom-url` - URL to a project containing a BOM. Defaults to Spring Cloud Release Git repository: `https://github.com/spring-cloud/spring-cloud-release`.
|
|
|
|
|
- `releaser.git.documentation-url` - URL to the documentation Git repository. Defaults to `https://github.com/spring-cloud/spring-cloud-static`.
|
|
|
|
|
- `releaser.git.documentation-branch` - Branch to check out for the documentation project. Defaults to `gh-pages`.
|
|
|
|
|
- `releaser.sagan.update-sagan` - If `true` then will update project sagan with information about this project. Defaults to `true`.
|
|
|
|
|
|
|
|
|
|
- `releaser.sagan.docs-adocs-file` - Folder with asciidoctor files for docs. Defaults to `docs/src/main/asciidoc`.
|
|
|
|
|
- `releaser.sagan.index-section-file-name` - Name of the ascii doc file with core part of this project's Sagan project page. Will search under `releaser.sagan.docs-adocs-file` folder.
|
|
|
|
|
- `releaser.sagan.boot-section-file-name` - Name of the ascii doc file with boot part of this project's Sagan project page. Will search under `releaser.sagan.docs-adocs-file` folder.
|
|
|
|
|
- `releaser.git.oauth-token` - GitHub OAuth token to be used to interact with GitHub repo.
|
|
|
|
|
- `releaser.git.username` - Optional Git username. If not passed keys will be used for authentication.
|
|
|
|
|
- `releaser.git.password` - Optional Git password. If not passed keys will be used for authentication.
|
|
|
|
|
@@ -422,94 +431,7 @@ before running the app
|
|
|
|
|
|
|
|
|
|
== Building
|
|
|
|
|
|
|
|
|
|
:jdkversion: 1.7
|
|
|
|
|
|
|
|
|
|
=== Basic Compile and Test
|
|
|
|
|
|
|
|
|
|
To build the source you will need to install JDK {jdkversion}.
|
|
|
|
|
|
|
|
|
|
Spring Cloud uses Maven for most build-related activities, and you
|
|
|
|
|
should be able to get off the ground quite quickly by cloning the
|
|
|
|
|
project you are interested in and typing
|
|
|
|
|
|
|
|
|
|
----
|
|
|
|
|
$ ./mvnw install
|
|
|
|
|
----
|
|
|
|
|
|
|
|
|
|
NOTE: You can also install Maven (>=3.3.3) yourself and run the `mvn` command
|
|
|
|
|
in place of `./mvnw` in the examples below. If you do that you also
|
|
|
|
|
might need to add `-P spring` if your local Maven settings do not
|
|
|
|
|
contain repository declarations for spring pre-release artifacts.
|
|
|
|
|
|
|
|
|
|
NOTE: Be aware that you might need to increase the amount of memory
|
|
|
|
|
available to Maven by setting a `MAVEN_OPTS` environment variable with
|
|
|
|
|
a value like `-Xmx512m -XX:MaxPermSize=128m`. We try to cover this in
|
|
|
|
|
the `.mvn` configuration, so if you find you have to do it to make a
|
|
|
|
|
build succeed, please raise a ticket to get the settings added to
|
|
|
|
|
source control.
|
|
|
|
|
|
|
|
|
|
For hints on how to build the project look in `.travis.yml` if there
|
|
|
|
|
is one. There should be a "script" and maybe "install" command. Also
|
|
|
|
|
look at the "services" section to see if any services need to be
|
|
|
|
|
running locally (e.g. mongo or rabbit). Ignore the git-related bits
|
|
|
|
|
that you might find in "before_install" since they're related to setting git
|
|
|
|
|
credentials and you already have those.
|
|
|
|
|
|
|
|
|
|
The projects that require middleware generally include a
|
|
|
|
|
`docker-compose.yml`, so consider using
|
|
|
|
|
https://compose.docker.io/[Docker Compose] to run the middeware servers
|
|
|
|
|
in Docker containers. See the README in the
|
|
|
|
|
https://github.com/spring-cloud-samples/scripts[scripts demo
|
|
|
|
|
repository] for specific instructions about the common cases of mongo,
|
|
|
|
|
rabbit and redis.
|
|
|
|
|
|
|
|
|
|
NOTE: If all else fails, build with the command from `.travis.yml` (usually
|
|
|
|
|
`./mvnw install`).
|
|
|
|
|
|
|
|
|
|
=== Documentation
|
|
|
|
|
|
|
|
|
|
The spring-cloud-build module has a "docs" profile, and if you switch
|
|
|
|
|
that on it will try to build asciidoc sources from
|
|
|
|
|
`src/main/asciidoc`. As part of that process it will look for a
|
|
|
|
|
`README.adoc` and process it by loading all the includes, but not
|
|
|
|
|
parsing or rendering it, just copying it to `${main.basedir}`
|
|
|
|
|
(defaults to `${basedir}`, i.e. the root of the project). If there are
|
|
|
|
|
any changes in the README it will then show up after a Maven build as
|
|
|
|
|
a modified file in the correct place. Just commit it and push the change.
|
|
|
|
|
|
|
|
|
|
=== Working with the code
|
|
|
|
|
If you don't have an IDE preference we would recommend that you use
|
|
|
|
|
https://www.springsource.com/developer/sts[Spring Tools Suite] or
|
|
|
|
|
https://eclipse.org[Eclipse] when working with the code. We use the
|
|
|
|
|
https://eclipse.org/m2e/[m2eclipse] eclipse plugin for maven support. Other IDEs and tools
|
|
|
|
|
should also work without issue as long as they use Maven 3.3.3 or better.
|
|
|
|
|
|
|
|
|
|
==== Importing into eclipse with m2eclipse
|
|
|
|
|
We recommend the https://eclipse.org/m2e/[m2eclipse] eclipse plugin when working with
|
|
|
|
|
eclipse. If you don't already have m2eclipse installed it is available from the "eclipse
|
|
|
|
|
marketplace".
|
|
|
|
|
|
|
|
|
|
NOTE: Older versions of m2e do not support Maven 3.3, so once the
|
|
|
|
|
projects are imported into Eclipse you will also need to tell
|
|
|
|
|
m2eclipse to use the right profile for the projects. If you
|
|
|
|
|
see many different errors related to the POMs in the projects, check
|
|
|
|
|
that you have an up to date installation. If you can't upgrade m2e,
|
|
|
|
|
add the "spring" profile to your `settings.xml`. Alternatively you can
|
|
|
|
|
copy the repository settings from the "spring" profile of the parent
|
|
|
|
|
pom into your `settings.xml`.
|
|
|
|
|
|
|
|
|
|
==== Importing into eclipse without m2eclipse
|
|
|
|
|
If you prefer not to use m2eclipse you can generate eclipse project metadata using the
|
|
|
|
|
following command:
|
|
|
|
|
|
|
|
|
|
[indent=0]
|
|
|
|
|
----
|
|
|
|
|
$ ./mvnw eclipse:eclipse
|
|
|
|
|
----
|
|
|
|
|
|
|
|
|
|
The generated eclipse projects can be imported by selecting `import existing projects`
|
|
|
|
|
from the `file` menu.
|
|
|
|
|
|
|
|
|
|
Unresolved directive in README.adoc - include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/docs/src/main/asciidoc/building.adoc[]
|
|
|
|
|
|
|
|
|
|
IMPORTANT: There are 2 different versions of language level used in Spring Cloud Sleuth. Java 1.7 is used for main sources and
|
|
|
|
|
Java 1.8 is used for tests. When importing your project to an IDE please activate the `ide` Maven profile to turn on
|
|
|
|
|
@@ -518,47 +440,4 @@ so your app will break during the Maven build.
|
|
|
|
|
|
|
|
|
|
== Contributing
|
|
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
=== Sign the Contributor License Agreement
|
|
|
|
|
Before we accept a non-trivial patch or pull request we will need you to sign the
|
|
|
|
|
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
|
|
|
|
|
given the ability to merge pull requests.
|
|
|
|
|
|
|
|
|
|
=== Code of Conduct
|
|
|
|
|
This project adheres to the Contributor Covenant https://github.com/spring-cloud/spring-cloud-build/blob/master/docs/src/main/asciidoc/code-of-conduct.adoc[code of
|
|
|
|
|
conduct]. By participating, you are expected to uphold this code. Please report
|
|
|
|
|
unacceptable behavior to spring-code-of-conduct@pivotal.io.
|
|
|
|
|
|
|
|
|
|
=== 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
|
|
|
|
|
https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-dependencies-parent/eclipse-code-formatter.xml[Spring
|
|
|
|
|
Cloud Build] project. If using IntelliJ, you can use the
|
|
|
|
|
https://plugins.jetbrains.com/plugin/6546[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 https://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).
|
|
|
|
|
Unresolved directive in README.adoc - include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/docs/src/main/asciidoc/contributing.adoc[]
|
Marcin Grzejszczak