Update installation instructions for CLI
Fixes gh-4
This commit is contained in:
108
README.adoc
108
README.adoc
@@ -1,5 +1,7 @@
|
|||||||
// Do not edit this file (e.g. go instead to src/main/asciidoc)
|
// Do not edit this file (e.g. go instead to src/main/asciidoc)
|
||||||
|
|
||||||
|
image::https://travis-ci.org/spring-cloud/spring-cloud-cli.svg?branch=master[Build Status, link=https://travis-ci.org/spring-cloud/spring-cloud-cli]
|
||||||
|
|
||||||
Spring Boot command line features for
|
Spring Boot command line features for
|
||||||
https://github.com/spring-cloud[Spring Cloud].
|
https://github.com/spring-cloud[Spring Cloud].
|
||||||
|
|
||||||
@@ -9,31 +11,19 @@ https://github.com/spring-cloud[Spring Cloud].
|
|||||||
To install, make
|
To install, make
|
||||||
sure you have
|
sure you have
|
||||||
https://github.com/spring-projects/spring-boot[Spring Boot CLI]
|
https://github.com/spring-projects/spring-boot[Spring Boot CLI]
|
||||||
(1.1.x with x>=5):
|
(1.2.0.RC1 or better):
|
||||||
|
|
||||||
$ spring version
|
$ spring version
|
||||||
Spring CLI v1.1.8.RELEASE
|
Spring CLI v1.2.0.RC1
|
||||||
|
|
||||||
E.g. for GVM users
|
E.g. for GVM users
|
||||||
|
|
||||||
```
|
```
|
||||||
$ gvm install springboot 1.1.8.RELEASE
|
$ gvm install springboot 1.2.0.RC1
|
||||||
$ gvm use springboot 1.1.8.RELEASE
|
$ gvm use springboot 1.2.0.RC1
|
||||||
```
|
```
|
||||||
|
|
||||||
then get the install command plugin (backported from Boot 1.2.0):
|
and install the Spring Cloud plugin:
|
||||||
|
|
||||||
```
|
|
||||||
$ wget http://dl.bintray.com/dsyer/generic/install-0.0.2.jar
|
|
||||||
```
|
|
||||||
|
|
||||||
install it in the Spring Boot CLI, e.g. with GVM (MacOS users that rely on brew might have to find the `/lib` directory by scanning `brew info springboot`):
|
|
||||||
|
|
||||||
```
|
|
||||||
$ cp install-0.0.2.jar ~/.gvm/springboot/1.1.8.RELEASE/lib
|
|
||||||
```
|
|
||||||
|
|
||||||
and finally install the Spring Cloud plugin:
|
|
||||||
|
|
||||||
```
|
```
|
||||||
$ mvn install
|
$ mvn install
|
||||||
@@ -42,7 +32,7 @@ $ spring install org.springframework.cloud:spring-cloud-cli:1.0.0.BUILD-SNAPSHOT
|
|||||||
|
|
||||||
== Building
|
== Building
|
||||||
|
|
||||||
== Basic Compile and Test
|
=== Basic Compile and Test
|
||||||
|
|
||||||
To build the source you will need to install
|
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.
|
http://maven.apache.org/run-maven/index.html[Apache Maven] v3.0.6 or above and JDK 1.7.
|
||||||
@@ -69,12 +59,12 @@ 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 will be able git
|
||||||
credentials and you already have those.
|
credentials and you already have those.
|
||||||
|
|
||||||
If you need mongo, rabbit or redis, see the README in the [scripts
|
If you need mongo, rabbit or redis, see the README in the https://github.com/spring-cloud-samples/scripts[scripts
|
||||||
demo repository](https://github.com/spring-cloud-samples/scripts) for
|
demo repository] for
|
||||||
instructions. For example consider using the "fig.yml" with
|
instructions. For example consider using the "fig.yml" with
|
||||||
[Fig](http://www.fig.sh/) to run them in Docker containers.
|
http://www.fig.sh/[Fig] to run them in Docker containers.
|
||||||
|
|
||||||
== Documentation
|
=== Documentation
|
||||||
|
|
||||||
The spring-cloud-build module has a "docs" profile, and if you switch
|
The spring-cloud-build module has a "docs" profile, and if you switch
|
||||||
that on it will try to build asciidoc sources from
|
that on it will try to build asciidoc sources from
|
||||||
@@ -85,7 +75,7 @@ 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
|
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.
|
a modified file in the correct place. Just commit it and push the change.
|
||||||
|
|
||||||
== Pull Requests
|
=== Pull Requests
|
||||||
|
|
||||||
Spring Cloud is released under the non-restrictive Apache 2.0 license,
|
Spring Cloud is released under the non-restrictive Apache 2.0 license,
|
||||||
and follows a very standard Github development process, using Github
|
and follows a very standard Github development process, using Github
|
||||||
@@ -93,7 +83,7 @@ tracker for issues and merging pull requests into master. If you want
|
|||||||
to contribute even something trivial please do not hesitate, but
|
to contribute even something trivial please do not hesitate, but
|
||||||
follow the guidelines below.
|
follow the guidelines below.
|
||||||
|
|
||||||
=== Sign the Contributor License Agreement
|
==== Sign the Contributor License Agreement
|
||||||
Before we accept a non-trivial patch or pull request we will need you
|
Before we accept a non-trivial patch or pull request we will need you
|
||||||
to sign the
|
to sign the
|
||||||
https://support.springsource.com/spring_committer_signup[contributor's
|
https://support.springsource.com/spring_committer_signup[contributor's
|
||||||
@@ -103,7 +93,7 @@ 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
|
Active contributors might be asked to join the core team, and given
|
||||||
the ability to merge pull requests.
|
the ability to merge pull requests.
|
||||||
|
|
||||||
=== Code Conventions and Housekeeping
|
==== Code Conventions and Housekeeping
|
||||||
None of these is essential for a pull request, but they will all help. They can also be
|
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.
|
added after the original pull request but before a merge.
|
||||||
|
|
||||||
@@ -132,12 +122,12 @@ http://eclipse.org[Eclipse] when working with the code. We use the
|
|||||||
http://eclipse.org/m2e/[m2eclipe] eclipse plugin for maven support. Other IDEs and tools
|
http://eclipse.org/m2e/[m2eclipe] eclipse plugin for maven support. Other IDEs and tools
|
||||||
should also work without issue.
|
should also work without issue.
|
||||||
|
|
||||||
=== Importing into eclipse with m2eclipse
|
==== Importing into eclipse with m2eclipse
|
||||||
We recommend the http://eclipse.org/m2e/[m2eclipe] eclipse plugin when working with
|
We recommend the http://eclipse.org/m2e/[m2eclipe] eclipse plugin when working with
|
||||||
eclipse. If you don't already have m2eclipse installed it is available from the "eclipse
|
eclipse. If you don't already have m2eclipse installed it is available from the "eclipse
|
||||||
marketplace".
|
marketplace".
|
||||||
|
|
||||||
=== Importing into eclipse without m2eclipse
|
==== Importing into eclipse without m2eclipse
|
||||||
If you prefer not to use m2eclipse you can generate eclipse project metadata using the
|
If you prefer not to use m2eclipse you can generate eclipse project metadata using the
|
||||||
following command:
|
following command:
|
||||||
|
|
||||||
@@ -149,5 +139,65 @@ following command:
|
|||||||
The generated eclipse projects can be imported by selecting `import existing projects`
|
The generated eclipse projects can be imported by selecting `import existing projects`
|
||||||
from the `file` menu.
|
from the `file` menu.
|
||||||
|
|
||||||
=== Importing into other IDEs
|
==== Adding Project Lombok Agent
|
||||||
Maven is well supported by most Java IDEs. Refer to you vendor documentation.
|
|
||||||
|
Spring Cloud uses [Project
|
||||||
|
Lombok](http://projectlombok.org/features/index.html) 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
|
||||||
|
missing methods and fields, e.g.
|
||||||
|
|
||||||
|
[indent=0]
|
||||||
|
----
|
||||||
|
The method getInitialStatus() is undefined for the type EurekaInstanceConfigBean EurekaDiscoveryClientConfiguration.java /spring-cloud-netflix-core/src/main/java/org/springframework/cloud/netflix/eureka line 120 Java Problem
|
||||||
|
The method getInitialStatus() is undefined for the type EurekaInstanceConfigBean EurekaDiscoveryClientConfiguration.java /spring-cloud-netflix-core/src/main/java/org/springframework/cloud/netflix/eureka line 121 Java Problem
|
||||||
|
The method setNonSecurePort(int) is undefined for the type EurekaInstanceConfigBean EurekaDiscoveryClientConfiguration.java /spring-cloud-netflix-core/src/main/java/org/springframework/cloud/netflix/eureka line 112 Java Problem
|
||||||
|
The type EurekaInstanceConfigBean.IdentifyingDataCenterInfo must implement the inherited abstract method DataCenterInfo.getName() EurekaInstanceConfigBean.java /spring-cloud-netflix-core/src/main/java/org/springframework/cloud/netflix/eureka line 131 Java Problem
|
||||||
|
The method getId() is undefined for the type ProxyRouteLocator.ProxyRouteSpec PreDecorationFilter.java /spring-cloud-netflix-core/src/main/java/org/springframework/cloud/netflix/zuul/filters/pre line 60 Java Problem
|
||||||
|
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 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.
|
||||||
|
|
||||||
|
=== 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
|
||||||
|
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
|
||||||
|
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.
|
||||||
|
* 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 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).
|
||||||
@@ -1,3 +1,5 @@
|
|||||||
|
image::https://travis-ci.org/spring-cloud/spring-cloud-cli.svg?branch=master[Build Status, link=https://travis-ci.org/spring-cloud/spring-cloud-cli]
|
||||||
|
|
||||||
include::intro.adoc[]
|
include::intro.adoc[]
|
||||||
|
|
||||||
== Installation
|
== Installation
|
||||||
|
|||||||
Reference in New Issue
Block a user