From 050971dc71440935cf34bfc3e3ab5806cd073e81 Mon Sep 17 00:00:00 2001 From: Marcin Grzejszczak Date: Fri, 10 Mar 2017 15:58:53 +0100 Subject: [PATCH] Updated docs --- README.adoc | 11 +++++++++++ .../src/main/asciidoc/spring-cloud-release-tools.adoc | 11 +++++++++++ 2 files changed, 22 insertions(+) diff --git a/README.adoc b/README.adoc index 792f788e..b6e5cf8b 100644 --- a/README.adoc +++ b/README.adoc @@ -23,6 +23,17 @@ image::https://codecov.io/gh/{org}/{repo}/branch/{branch}/graph/badge.svg["codec Spring Cloud projects reuse the same pattern of building and deploying the applications. That's why this tool makes it easy to automate the release / dependency update process of our applications. +=== What does it do? + +- Clones the Spring Cloud Release project and picks all versions (Boot + Cloud projects) +- Modifies the project versions with values from SC-Release +- Performs the build and checks if the `docs` modules have properly created the documentation (no `unresolved` tags are present) +- Commits changed poms (ONLY FOR NON-SNAPSHOT VERSIONS) +- Creates a tag for the release / milestone (ONLY FOR NON-SNAPSHOT VERSIONS) +- Runs the deployment of the artifacts +- Publishes the docs (to `spring-cloud-static` for non-snapshots, to `gh-pages` for snapshots) +- Reverts back to snapshots, bumps the version by a patch (`1.0.1.RELEASE` -> `1.0.2.BUILD-SNAPSHOT`) (ONLY FOR NON-SNAPSHOT VERSIONS) + === How to run it Currently we only support running the Releaser to update the poms from Java diff --git a/docs/src/main/asciidoc/spring-cloud-release-tools.adoc b/docs/src/main/asciidoc/spring-cloud-release-tools.adoc index 4edc81ea..dbcb7ce9 100644 --- a/docs/src/main/asciidoc/spring-cloud-release-tools.adoc +++ b/docs/src/main/asciidoc/spring-cloud-release-tools.adoc @@ -13,6 +13,17 @@ Spring Cloud projects reuse the same pattern of building and deploying the applications. That's why this tool makes it easy to automate the release / dependency update process of our applications. +=== What does it do? + +- Clones the Spring Cloud Release project and picks all versions (Boot + Cloud projects) +- Modifies the project versions with values from SC-Release +- Performs the build and checks if the `docs` modules have properly created the documentation (no `unresolved` tags are present) +- Commits changed poms (ONLY FOR NON-SNAPSHOT VERSIONS) +- Creates a tag for the release / milestone (ONLY FOR NON-SNAPSHOT VERSIONS) +- Runs the deployment of the artifacts +- Publishes the docs (to `spring-cloud-static` for non-snapshots, to `gh-pages` for snapshots) +- Reverts back to snapshots, bumps the version by a patch (`1.0.1.RELEASE` -> `1.0.2.BUILD-SNAPSHOT`) (ONLY FOR NON-SNAPSHOT VERSIONS) + === How to run it Currently we only support running the Releaser to update the poms from Java