From f49592fcfd859bfec2899868f840e2bb7bb2b1ea Mon Sep 17 00:00:00 2001 From: Marcin Grzejszczak Date: Tue, 30 Oct 2018 13:00:39 +0100 Subject: [PATCH] Updated docs' --- README.adoc | 22 +++++++++---------- .../asciidoc/spring-cloud-release-tools.adoc | 22 +++++++++---------- 2 files changed, 22 insertions(+), 22 deletions(-) diff --git a/README.adoc b/README.adoc index ea57c8ef..080076f8 100644 --- a/README.adoc +++ b/README.adoc @@ -278,19 +278,9 @@ Use these properties to provide versions for the meta release. Defaults to `https://github.com/spring-cloud` - `releaser.meta-release.projects-to-skip` - List of projects that we should not clone and release. Spring Cloud release train depends on projects that got already released. We default this list to `[spring-boot, spring-cloud-stream, spring-cloud-task]`. - -The following properties are used for both meta release and a release of an individual module. - -- `releaser.meta-release.release-train-project-name` - Name of the project that represents the BOM of the release train. Defaults to `spring-cloud-release`. -- `releaser.git.fetch-versions-from-git` - If `true` then should fill the map of versions from Git. If `false` then picks fixed versions. -- `releaser.git.clone-destination-dir` - Where should the Spring Cloud Release repo get cloned to. If null defaults to a temporary directory. -- `releaser.git.release-train-bom-url` - URL to a project containing a BOM. Defaults to Spring Cloud Release Git repository: `https://github.com/spring-cloud/spring-cloud-release`. -- `releaser.git.documentation-url` - URL to the documentation Git repository. Defaults to `https://github.com/spring-cloud/spring-cloud-static`. -- `releaser.git.documentation-branch` - Branch to check out for the documentation project. Defaults to `gh-pages`. - `releaser.git.update-documentation-repo` - If `true` then will update documentation repository with the `current` URL. Defaults to `true`. - `releaser.git.spring-project-url` - URL to the documentation Git repository. Defaults to `https://github.com/spring-projects/spring-cloud`. - `releaser.git.spring-project-branch` - Branch to check out for the documentation project. Defaults to `gh-pages`. -- `releaser.sagan.update-sagan` - Branch to check out for the documentation project. Defaults to `gh-pages`. - `releaser.git.update-spring-project` - If `true` then will update Project Sagan with the current release train values. Defaults to `true`. - `releaser.git.test-samples-project-url` - URL to the test samples to be checked against the given release train. Defaults to `https://github.com/spring-cloud/spring-cloud-core-tests`. - `releaser.git.test-samples-project-branch` - Branch to check out for test samples. Defaults to `master`. @@ -300,11 +290,21 @@ The following properties are used for both meta release and a release of an indi - `releaser.git.all-test-samples-urls` - URLs to the test samples to be cloned and updated with proper snapshot versions. E.g. `"--releaser.git.all-test-samples-urls[spring-cloud-sleuth]=https://github.com/spring-cloud-samples/sleuth-issues/,https://github.com/spring-cloud-samples/sleuth-documentation-apps/"`. Defaults to Sleuth and Contract samples. -- `releaser.git.update-all-test-samples` - If `true` then will update samples and run the the build. Defaults to `true`. +- `releaser.git.update-all-test-samples` - If `true` then will update samples with bumped snapshots after release. Defaults to `true`. - `releaser.git.release-train-docs-url` - URL to the release train documentation. Defaults to `https://github.com/spring-cloud-sample/scripts`. - `releaser.git.release-train-docs-branch` - Branch to check out for release train documentation. Defaults to `master`. - `releaser.git.update-release-train-docs` - If `true` then will update the release train documentation project and run the generation. Defaults to `true`. - `releaser.git.update-spring-guides` - If `true` then will update Spring Guides with the current release train. Defaults to `true`. + +The following properties are used for both meta release and a release of an individual module. + +- `releaser.meta-release.release-train-project-name` - Name of the project that represents the BOM of the release train. Defaults to `spring-cloud-release`. +- `releaser.git.fetch-versions-from-git` - If `true` then should fill the map of versions from Git. If `false` then picks fixed versions. +- `releaser.git.clone-destination-dir` - Where should the Spring Cloud Release repo get cloned to. If null defaults to a temporary directory. +- `releaser.git.release-train-bom-url` - URL to a project containing a BOM. Defaults to Spring Cloud Release Git repository: `https://github.com/spring-cloud/spring-cloud-release`. +- `releaser.git.documentation-url` - URL to the documentation Git repository. Defaults to `https://github.com/spring-cloud/spring-cloud-static`. +- `releaser.git.documentation-branch` - Branch to check out for the documentation project. Defaults to `gh-pages`. +- `releaser.sagan.update-sagan` - Branch to check out for the documentation project. Defaults to `gh-pages`. - `releaser.git.oauth-token` - GitHub OAuth token to be used to interact with GitHub repo. - `releaser.git.username` - Optional Git username. If not passed keys will be used for authentication. - `releaser.git.password` - Optional Git password. If not passed keys will be used for authentication. diff --git a/docs/src/main/asciidoc/spring-cloud-release-tools.adoc b/docs/src/main/asciidoc/spring-cloud-release-tools.adoc index 11103c42..f9f11dee 100644 --- a/docs/src/main/asciidoc/spring-cloud-release-tools.adoc +++ b/docs/src/main/asciidoc/spring-cloud-release-tools.adoc @@ -268,19 +268,9 @@ Use these properties to provide versions for the meta release. Defaults to `https://github.com/spring-cloud` - `releaser.meta-release.projects-to-skip` - List of projects that we should not clone and release. Spring Cloud release train depends on projects that got already released. We default this list to `[spring-boot, spring-cloud-stream, spring-cloud-task]`. - -The following properties are used for both meta release and a release of an individual module. - -- `releaser.meta-release.release-train-project-name` - Name of the project that represents the BOM of the release train. Defaults to `spring-cloud-release`. -- `releaser.git.fetch-versions-from-git` - If `true` then should fill the map of versions from Git. If `false` then picks fixed versions. -- `releaser.git.clone-destination-dir` - Where should the Spring Cloud Release repo get cloned to. If null defaults to a temporary directory. -- `releaser.git.release-train-bom-url` - URL to a project containing a BOM. Defaults to Spring Cloud Release Git repository: `https://github.com/spring-cloud/spring-cloud-release`. -- `releaser.git.documentation-url` - URL to the documentation Git repository. Defaults to `https://github.com/spring-cloud/spring-cloud-static`. -- `releaser.git.documentation-branch` - Branch to check out for the documentation project. Defaults to `gh-pages`. - `releaser.git.update-documentation-repo` - If `true` then will update documentation repository with the `current` URL. Defaults to `true`. - `releaser.git.spring-project-url` - URL to the documentation Git repository. Defaults to `https://github.com/spring-projects/spring-cloud`. - `releaser.git.spring-project-branch` - Branch to check out for the documentation project. Defaults to `gh-pages`. -- `releaser.sagan.update-sagan` - Branch to check out for the documentation project. Defaults to `gh-pages`. - `releaser.git.update-spring-project` - If `true` then will update Project Sagan with the current release train values. Defaults to `true`. - `releaser.git.test-samples-project-url` - URL to the test samples to be checked against the given release train. Defaults to `https://github.com/spring-cloud/spring-cloud-core-tests`. - `releaser.git.test-samples-project-branch` - Branch to check out for test samples. Defaults to `master`. @@ -290,11 +280,21 @@ The following properties are used for both meta release and a release of an indi - `releaser.git.all-test-samples-urls` - URLs to the test samples to be cloned and updated with proper snapshot versions. E.g. `"--releaser.git.all-test-samples-urls[spring-cloud-sleuth]=https://github.com/spring-cloud-samples/sleuth-issues/,https://github.com/spring-cloud-samples/sleuth-documentation-apps/"`. Defaults to Sleuth and Contract samples. -- `releaser.git.update-all-test-samples` - If `true` then will update samples and run the the build. Defaults to `true`. +- `releaser.git.update-all-test-samples` - If `true` then will update samples with bumped snapshots after release. Defaults to `true`. - `releaser.git.release-train-docs-url` - URL to the release train documentation. Defaults to `https://github.com/spring-cloud-sample/scripts`. - `releaser.git.release-train-docs-branch` - Branch to check out for release train documentation. Defaults to `master`. - `releaser.git.update-release-train-docs` - If `true` then will update the release train documentation project and run the generation. Defaults to `true`. - `releaser.git.update-spring-guides` - If `true` then will update Spring Guides with the current release train. Defaults to `true`. + +The following properties are used for both meta release and a release of an individual module. + +- `releaser.meta-release.release-train-project-name` - Name of the project that represents the BOM of the release train. Defaults to `spring-cloud-release`. +- `releaser.git.fetch-versions-from-git` - If `true` then should fill the map of versions from Git. If `false` then picks fixed versions. +- `releaser.git.clone-destination-dir` - Where should the Spring Cloud Release repo get cloned to. If null defaults to a temporary directory. +- `releaser.git.release-train-bom-url` - URL to a project containing a BOM. Defaults to Spring Cloud Release Git repository: `https://github.com/spring-cloud/spring-cloud-release`. +- `releaser.git.documentation-url` - URL to the documentation Git repository. Defaults to `https://github.com/spring-cloud/spring-cloud-static`. +- `releaser.git.documentation-branch` - Branch to check out for the documentation project. Defaults to `gh-pages`. +- `releaser.sagan.update-sagan` - Branch to check out for the documentation project. Defaults to `gh-pages`. - `releaser.git.oauth-token` - GitHub OAuth token to be used to interact with GitHub repo. - `releaser.git.username` - Optional Git username. If not passed keys will be used for authentication. - `releaser.git.password` - Optional Git password. If not passed keys will be used for authentication.