diff --git a/README.adoc b/README.adoc index bfec0e7..82810ea 100644 --- a/README.adoc +++ b/README.adoc @@ -1,4 +1,4 @@ -// Do not edit this file (e.g. go instead to src/main/asciidoc) +// Do not edit this file (e.g. go instead to docs/src/main/asciidoc) = Spring Cloud Bus @@ -23,37 +23,49 @@ The bus currently supports sending messages to all nodes listening or all nodes == Building +:jdkversion: 1.7 + === Basic Compile and Test -To build the source you will need to install -http://maven.apache.org/run-maven/index.html[Apache Maven] v3.0.6 or above and JDK 1.7. +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 ---- -$ mvn install -s .settings.xml +$ ./mvnw install ---- -NOTE: You may need to increase the amount of memory available to Maven by setting -a `MAVEN_OPTS` environment variable with the value `-Xmx512m -XX:MaxPermSize=128m` +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. -The `.settings.xml` is only required the first time (or after updates -to dependencies). It is there to provide repository declarations so -that those do not need to be hard coded in the project poms. +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 will be able git +that you might find in "before_install" since they're related to setting git credentials and you already have those. -If you need mongo, rabbit or redis, see the README in the https://github.com/spring-cloud-samples/scripts[scripts -demo repository] for -instructions. For example consider using the "fig.yml" with -http://www.fig.sh/[Fig] to run them in Docker containers. +The projects that require middleware generally include a +`docker-compose.yml`, so consider using +http://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 @@ -66,46 +78,6 @@ parsing or rendering it, just copying it to `${main.basedir}` 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. -=== Pull Requests - -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://support.springsource.com/spring_committer_signup[contributor's -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 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 and you follow - the ``Importing into eclipse'' instructions below you should get project specific - formatting automatically. You can also import formatter settings using the - `eclipse-code-formatter.xml` file from the `eclipse` folder. If using IntelliJ, you can - use the http://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). - === Working with the code If you don't have an IDE preference we would recommend that you use http://www.springsource.com/developer/sts[Spring Tools Suite] or @@ -118,13 +90,25 @@ We recommend the http://eclipse.org/m2e/[m2eclipe] eclipse plugin when working w eclipse. If you don't already have m2eclipse installed it is available from the "eclipse marketplace". +Unfortunately m2e does not yet support Maven 3.3, so once the projects +are imported into Eclipse you will also need to tell m2eclipse to use +the `.settings.xml` file for the projects. If you do not do this you +may see many different errors related to the POMs in the +projects. Open your Eclipse preferences, expand the Maven +preferences, and select User Settings. In the User Settings field +click Browse and navigate to the Spring Cloud project you imported +selecting the `.settings.xml` file in that project. Click Apply and +then OK to save the preference changes. + +NOTE: Alternatively you can copy the repository settings from https://github.com/spring-cloud/spring-cloud-build/blob/master/.settings.xml[`.settings.xml`] into your own `~/.m2/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] ---- - $ mvn eclipse:eclipse + $ ./mvnw eclipse:eclipse ---- The generated eclipse projects can be imported by selecting `import existing projects` @@ -132,9 +116,8 @@ from the `file` menu. ==== Adding Project Lombok Agent -Spring Cloud uses [Project -Lombok](http://projectlombok.org/features/index.html) to generate -getters and setters etc. Compiling from the command line this +Spring Cloud uses http://projectlombok.org/features/index.html[Project Lombok] +to generate getters and setters etc. Compiling from the command line this shouldn't cause any problems, but in an IDE you need to add an agent to the JVM. Full instructions can be found in the Lombok website. The sign that you need to do this is a lot of compiler errors to do with @@ -150,14 +133,29 @@ The method getId() is undefined for the type ProxyRouteLocator.ProxyRouteSpec The method getLocation() is undefined for the type ProxyRouteLocator.ProxyRouteSpec PreDecorationFilter.java /spring-cloud-netflix-core/src/main/java/org/springframework/cloud/netflix/zuul/filters/pre line 55 Java Problem ---- +==== Importing into Intellij +Spring Cloud projects use annotation processing, particularly Lombok, which requires configuration +or you will encounter compile problems. It also needs a specific version of maven and a profile +enabled. Intellij 14.1+ requires some configuration to ensure these are setup properly. + + 1. Click Preferences, Plugins. *Ensure Lombok is installed* + 2. Click New, Project from Existing Sources, choose your spring-cloud-sleuth directory + 3. Choose Maven, and select Environment Settings. *Ensure you are using Maven 3.3.3* + 4. In the next screen, *Select the profile `spring`* click Next until Finish. + 5. Click Preferences, "Build, Execution, Deployment", Compiler, Annotation Processors. *Click Enable Annotation Processing* + 6. Click Build, Rebuild Project, and you are ready to go! + ==== Importing into other IDEs Maven is well supported by most Java IDEs. Refer to you vendor documentation. + == Contributing -Spring Cloud is released under the non-restrictive Apache 2.0 license. If you would like -to contribute something, or simply want to hack on the code this document should help -you get started. +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 @@ -167,6 +165,11 @@ repository, but it does mean that we can accept your contributions, and you will 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. @@ -174,7 +177,7 @@ 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://github.com/spring-cloud/build/tree/master/eclipse-coding-conventions.xml[Spring + 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 http://plugins.jetbrains.com/plugin/6546[Eclipse Code Formatter Plugin] to import the same file. diff --git a/docs/src/main/asciidoc/spring-cloud-bus.adoc b/docs/src/main/asciidoc/spring-cloud-bus.adoc index 091874f..7cad8b4 100644 --- a/docs/src/main/asciidoc/spring-cloud-bus.adoc +++ b/docs/src/main/asciidoc/spring-cloud-bus.adoc @@ -1,5 +1,5 @@ = Spring Cloud Bus -:github: https://github.com/spring-cloud/spring-cloud-config +:github: https://github.com/spring-cloud/spring-cloud-bus :githubmaster: {github}/tree/master :docslink: {githubmaster}/docs/src/main/asciidoc :toc: diff --git a/pom.xml b/pom.xml index a64c54a..4f97223 100644 --- a/pom.xml +++ b/pom.xml @@ -6,7 +6,6 @@ spring-cloud-bus-parent 1.0.4.BUILD-SNAPSHOT pom - spring-cloud-bus-parent Spring Cloud Bus Parent