From cf9c4fbf9fe99e7aa623322cd64e20248e5baa71 Mon Sep 17 00:00:00 2001 From: Greg Turnquist Date: Mon, 16 Oct 2017 12:22:41 -0500 Subject: [PATCH] Polishing --- README.adoc | 48 +++++++++++++++++++++++++++++++++++------------- 1 file changed, 35 insertions(+), 13 deletions(-) diff --git a/README.adoc b/README.adoc index d4f7191f..1725a314 100644 --- a/README.adoc +++ b/README.adoc @@ -14,27 +14,49 @@ as well as our own repository, http://repo.spring.io/release[http://repo.springs Please visit https://projects.spring.io/spring-ws to get the right Maven/Gradle settings for your selected version. -== Building from Source +== Building Spring Web Services -Spring Web Services uses a http://gradle.org[Gradle]-based build system. In -the instructions below, http://vimeo.com/34436402[`./gradlew`] is invoked -from the root of the source tree and serves as a cross-platform, self-contained -bootstrap mechanism for the build. The only prerequisites are -http://help.github.com/set-up-git-redirect[Git] and JDK 1.7+. +. Run `mvn clean package` -=== check out sources +This will generate the artifacts. -`git clone git://github.com/spring-projects/spring-ws.git` +You can also import the project into your IDE. -=== compile and test, build all jars, distribution zips and docs +== Releasing Spring Web Services -`./gradlew build` +Snapshots are published automatically via CI server by doing this: -=== install all spring-* jars into your local Maven cache +---- +$ USERNAME= PASSWORD= ./mvnw -Pdistribute,snapshot,docs clean -Dmaven.test.skip=true deploy +---- -`./gradlew install` +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. -… 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]. +To do a release (.RELEASE, .RC?, .M?): + +. Check in all changes and ensure there are no edited files. +. Bump up the version in ALL `pom.xml` files to the desired version and commit the change. +. `git tag ` (like v3.0.0.RC1) +. Execute a maven test (`./mvnw -Pdistribute,snapshot,docs clean test`). +. Execute a maven deploy. +* For a milestone: `USERNAME= PASSWORD= ./mvnw -Pdistribute,gpg,milestone,docs clean -Dmaven.test.skip=true deploy` +* For a release: `USERNAME= PASSWORD= ./mvnw -Pdistribute,gpg,release,docs clean -Dmaven.test.skip=true deploy` +* For a release to maven central: `USERNAME= PASSWORD= ./mvnw -Pdistribute,gpg,central,docs clean -Dmaven.test.skip=true deploy -s settings.xml` +. Bump up the version in ALL `pom.xml` files again to the next BUILD-SNAPSHOT. +. Commit the change. +. `git push` (This will push the tagged version along with the release AND the new snapshot commit) +. Inspect handiwork at https://repo.spring.io/ or https://oss.sonatype.org/#stagingRepositories + +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. + +== Code of Conduct + +This project adheres to the Contributor Covenant link: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. + += Spring Web Services Project Site + +You can find the documentation, issue management, support, samples, and guides for using Spring Web Services at http://projects.spring.io/spring-ws/ == Documentation