Skip to content

Commit deb10c7

Browse files
committed
Backport build instructions
1 parent f1804a9 commit deb10c7

File tree

1 file changed

+35
-13
lines changed

1 file changed

+35
-13
lines changed

README.adoc

Lines changed: 35 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -14,27 +14,49 @@ as well as our own repository, http://repo.spring.io/release[http://repo.springs
1414

1515
Please visit https://projects.spring.io/spring-ws to get the right Maven/Gradle settings for your selected version.
1616

17-
== Building from Source
17+
== Building Spring Web Services
1818

19-
Spring Web Services uses a http://gradle.org[Gradle]-based build system. In
20-
the instructions below, http://vimeo.com/34436402[`./gradlew`] is invoked
21-
from the root of the source tree and serves as a cross-platform, self-contained
22-
bootstrap mechanism for the build. The only prerequisites are
23-
http://help.github.com/set-up-git-redirect[Git] and JDK 1.7+.
19+
. Run `mvn clean package`
2420

25-
=== check out sources
21+
This will generate the artifacts.
2622

27-
`git clone git://github.com/spring-projects/spring-ws.git`
23+
You can also import the project into your IDE.
2824

29-
=== compile and test, build all jars, distribution zips and docs
25+
== Releasing Spring Web Services
3026

31-
`./gradlew build`
27+
Snapshots are published automatically via CI server by doing this:
3228

33-
=== install all spring-* jars into your local Maven cache
29+
----
30+
$ USERNAME=<username> PASSWORD=<encrypted password> ./mvnw -Pdistribute,snapshot,docs clean -Dmaven.test.skip=true deploy
31+
----
3432

35-
`./gradlew install`
33+
IMPORTANT: Snapshots do NOT include GPG signatures. To do so would require putting a private key on the CI server. The process for releases (below) is manual and DOES include GPG signatures.
3634

37-
… and discover more commands with `./gradlew tasks`. See also the https://github.com/spring-projects/spring-framework/wiki/Gradle-build-and-release-FAQ[Gradle build and release FAQ].
35+
To do a release (.RELEASE, .RC?, .M?):
36+
37+
. Check in all changes and ensure there are no edited files.
38+
. Bump up the version in ALL `pom.xml` files to the desired version (e.g. `mvn versions:set -DnewVersion=3.0.0.RC1`) and commit the change.
39+
. `git tag <version>` (like v3.0.0.RC1)
40+
. Execute a maven test (`./mvnw -Pdistribute,snapshot,docs clean test`).
41+
. Execute a maven deploy.
42+
* For a milestone: `USERNAME=<user> PASSWORD=<encrypted password> ./mvnw -Pdistribute,milestone,docs clean -Dmaven.test.skip=true deploy`
43+
* For a release: `USERNAME=<user> PASSWORD=<encrypted password> ./mvnw -Pdistribute,release,docs clean -Dmaven.test.skip=true deploy`
44+
* For a release to maven central: `USERNAME=<user> PASSWORD=<nexus password> ./mvnw -Pdistribute,gpg,central,docs clean -Dmaven.test.skip=true deploy -s settings.xml`
45+
. Bump up the version in ALL `pom.xml` files again to the next BUILD-SNAPSHOT.
46+
. Commit the change.
47+
. `git push` (This will push the tagged version along with the release AND the new snapshot commit)
48+
. Inspect handiwork at https://repo.spring.io/ or https://oss.sonatype.org/#stagingRepositories
49+
50+
NOTE: A word about reference documentation. Based upon https://github.com/spring-projects/spring-framework/wiki/gradle-build-and-release-faq#user-content-wiki-docs_schema_dist_publication[this], the `distribute` profile contains an artifactory property that is applied to the ZIP file generated by the `docs` profile. A CRON job will scoop up the zipped up docs and unpack them inside the target location.
51+
52+
== Code of Conduct
53+
54+
This project adheres to the Contributor Covenant link:CODE_OF_CONDUCT.adoc[code of conduct].
55+
By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].
56+
57+
= Spring Web Services Project Site
58+
59+
You can find the documentation, issue management, support, samples, and guides for using Spring Web Services at http://projects.spring.io/spring-ws/
3860

3961
== Documentation
4062

0 commit comments

Comments
 (0)