Spring/spring-ws
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Polishing

Browse Source
This commit is contained in:
Greg Turnquist
2017-10-16 12:22:41 -05:00
parent 3a1e96a68a
commit cf9c4fbf9f
1 changed files with 35 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
README.adoc
View File

@@ -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=<username> PASSWORD=<encrypted 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 <version>` (like v3.0.0.RC1)
. Execute a maven test (`./mvnw -Pdistribute,snapshot,docs clean test`).
. Execute a maven deploy.
* For a milestone: `USERNAME=<user> PASSWORD=<encrypted password> ./mvnw -Pdistribute,gpg,milestone,docs clean -Dmaven.test.skip=true deploy`
* For a release: `USERNAME=<user> PASSWORD=<encrypted password> ./mvnw -Pdistribute,gpg,release,docs clean -Dmaven.test.skip=true deploy`
* 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`
. 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