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

Update README and remove .settings.xml where appropriate

Browse Source
This commit is contained in:
Dave Syer
2016-05-12 10:24:08 +01:00
parent 618e9adaa4
commit b7b2f8f67a
2 changed files with 14 additions and 117 deletions
Download Patch File Download Diff File Expand all files Collapse all files

66
.settings.xml
View File

@@ -1,66 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<settings>
<servers>
<server>
<id>repo.spring.io</id>
<username>${env.CI_DEPLOY_USERNAME}</username>
<password>${env.CI_DEPLOY_PASSWORD}</password>
</server>
</servers>
<profiles>
<profile>
<!--
N.B. this profile is only here to support users and IDEs that do not use Maven 3.3.
It isn't needed on the command line if you use the wrapper script (mvnw) or if you use
a native Maven with the right version. Eclipse users should points their Maven tooling to
this settings file, or copy the profile into their ~/.m2/settings.xml.
-->
<id>spring</id>
<activation><activeByDefault>true</activeByDefault></activation>
<repositories>
<repository>
<id>spring-snapshots</id>
<name>Spring Snapshots</name>
<url>http://repo.spring.io/libs-snapshot-local</url>
<snapshots>
<enabled>true</enabled>
</snapshots>
</repository>
<repository>
<id>spring-milestones</id>
<name>Spring Milestones</name>
<url>http://repo.spring.io/libs-milestone-local</url>
<snapshots>
<enabled>false</enabled>
</snapshots>
</repository>
<repository>
<id>spring-releases</id>
<name>Spring Releases</name>
<url>http://repo.spring.io/release</url>
<snapshots>
<enabled>false</enabled>
</snapshots>
</repository>
</repositories>
<pluginRepositories>
<pluginRepository>
<id>spring-snapshots</id>
<name>Spring Snapshots</name>
<url>http://repo.spring.io/libs-snapshot-local</url>
<snapshots>
<enabled>true</enabled>
</snapshots>
</pluginRepository>
<pluginRepository>
<id>spring-milestones</id>
<name>Spring Milestones</name>
<url>http://repo.spring.io/libs-milestone-local</url>
<snapshots>
<enabled>false</enabled>
</snapshots>
</pluginRepository>
</pluginRepositories>
</profile>
</profiles>
</settings>

65
README.adoc
View File

@@ -13,23 +13,23 @@ Config clients with secret configuration values.
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.3.0 or better): (1.3.5 or better):
$ spring version $ spring version
Spring CLI v1.3.2.RELEASE Spring CLI v1.3.5.RELEASE
E.g. for SDKMan users E.g. for SDKMan users
``` ```
$ sdk install springboot 1.3.2.RELEASE $ sdk install springboot 1.3.5.RELEASE
$ sdk use springboot 1.3.2.RELEASE $ sdk use springboot 1.3.5.RELEASE
``` ```
and install the Spring Cloud plugin: and install the Spring Cloud plugin:
``` ```
$ mvn install $ mvn install
$ spring install org.springframework.cloud:spring-cloud-cli:1.1.0.RC1 $ spring install org.springframework.cloud:spring-cloud-cli:1.1.0.RELEASE
``` ```
IMPORTANT: **Prerequisites:** to use the encryption and decryption features IMPORTANT: **Prerequisites:** to use the encryption and decryption features
@@ -100,24 +100,21 @@ If you don't have an IDE preference we would recommend that you use
http://www.springsource.com/developer/sts[Spring Tools Suite] or http://www.springsource.com/developer/sts[Spring Tools Suite] or
http://eclipse.org[Eclipse] when working with the code. We use the 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 as long as they use Maven 3.3.3 or better.
==== 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".
Unfortunately m2e does not yet support Maven 3.3, so once the projects NOTE: Older versions of m2e do not support Maven 3.3, so once the
are imported into Eclipse you will also need to tell m2eclipse to use projects are imported into Eclipse you will also need to tell
the `.settings.xml` file for the projects. If you do not do this you m2eclipse to use the right profile for the projects. If you
may see many different errors related to the POMs in the see many different errors related to the POMs in the projects, check
projects. Open your Eclipse preferences, expand the Maven that you have an up to date installation. If you can't upgrade m2e,
preferences, and select User Settings. In the User Settings field add the "spring" profile to your `settings.xml`. Alternatively you can
click Browse and navigate to the Spring Cloud project you imported copy the repository settings from the "spring" profile of the parent
selecting the `.settings.xml` file in that project. Click Apply and pom into your `settings.xml`.
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 ==== 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
@@ -131,40 +128,6 @@ 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.
==== Adding Project Lombok Agent
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
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 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 project 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 == Contributing