From 1d75ab39edce4bc284c3b6b60496941cf528f154 Mon Sep 17 00:00:00 2001 From: buildmaster Date: Tue, 23 Oct 2018 13:32:29 +0000 Subject: [PATCH] Sync docs from master to gh-pages --- multi/multi__spring_cloud_release_tools.html | 2 +- single/spring-cloud-release-tools.html | 2 +- spring-cloud-release-tools.xml | 3 +++ 3 files changed, 5 insertions(+), 2 deletions(-) diff --git a/multi/multi__spring_cloud_release_tools.html b/multi/multi__spring_cloud_release_tools.html index 66728243..c8eb7176 100644 --- a/multi/multi__spring_cloud_release_tools.html +++ b/multi/multi__spring_cloud_release_tools.html @@ -115,7 +115,7 @@ or build only tasks with names spring-cloud-build,spring-c the spring-cloud-cli.version to 1.0.0.RELEASE regardless of what was set in spring-cloud-release project. Example --releaser.fixed-versions[spring-cloud-cli]=1.0.0.RELEASE. Use these properties to provide versions for the meta release.
  • releaser.meta-release.enabled - You have to turn it on to enable a meta release. Defaults to false
  • releaser.meta-release.git-org-url - The URL of the Git organization. We’ll append each project’s name to it. 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.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.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.
    • releaser.git.update-documentation-repo - If true then will update documentation repository with the current URL. Defaults to true.
    • releaser.git.update-spring-guides - If true then will update Spring Guides with the current release train. Defaults to true.
    • releaser.git.update-spring-project - If true then will update Spring Project page with the current release train values. Defaults to true.
    • 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.
    • releaser.git.number-of-checked-milestones - In order not to iterate endlessly over milestones we introduce a threshold of milestones that +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.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.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.
    • releaser.git.run-updated-samples - If true then will update samples and run the the build. Defaults to true.
    • releaser.git.update-documentation-repo - If true then will update documentation repository with the current URL. Defaults to true.
    • releaser.git.update-spring-guides - If true then will update Spring Guides with the current release train. Defaults to true.
    • releaser.git.update-spring-project - If true then will update Spring Project page with the current release train values. Defaults to true.
    • 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.
    • releaser.git.number-of-checked-milestones - In order not to iterate endlessly over milestones we introduce a threshold of milestones that we will go through to find the matching milestone. Defaults to 10.
    • releaser.maven.build-command - Command to be executed to build the project. Defaults to ./mvnw clean install -Pdocs.
    • releaser.maven.deploy-command - Command to be executed to deploy a built project". Defaults to ./mvnw deploy -DskipTests -Pfast.
    • releaser.maven.publish-docs-commands - Command to be executed to deploy a built project. If present {{version}} will be replaced by the proper version. Defaults to the standard Spring Cloud wget and execution of ghpages.
    • releaser.maven.system-properties - Additional system properties that should be passed to any commands. If present {{systemProps}} will be replaced by the contents of this property.
    • releaser.maven.wait-time-in-minutes - Max wait time in minutes for the process to finish. Defaults to 20.
    • releaser.gradle.gradle-props-substitution - a map containing a key which is a property key inside gradle.properties and a value of a project name. E.g. in gradle.properties you have foo=1.0.0.BUILD-SNAPSHOT and you would like spring-cloud-contract version to diff --git a/single/spring-cloud-release-tools.html b/single/spring-cloud-release-tools.html index 8c305a13..8587a7c5 100644 --- a/single/spring-cloud-release-tools.html +++ b/single/spring-cloud-release-tools.html @@ -115,7 +115,7 @@ or build only tasks with names spring-cloud-build,spring-c the spring-cloud-cli.version to 1.0.0.RELEASE regardless of what was set in spring-cloud-release project. Example --releaser.fixed-versions[spring-cloud-cli]=1.0.0.RELEASE. Use these properties to provide versions for the meta release.
    • releaser.meta-release.enabled - You have to turn it on to enable a meta release. Defaults to false
    • releaser.meta-release.git-org-url - The URL of the Git organization. We’ll append each project’s name to it. 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.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.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.
    • releaser.git.update-documentation-repo - If true then will update documentation repository with the current URL. Defaults to true.
    • releaser.git.update-spring-guides - If true then will update Spring Guides with the current release train. Defaults to true.
    • releaser.git.update-spring-project - If true then will update Spring Project page with the current release train values. Defaults to true.
    • 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.
    • releaser.git.number-of-checked-milestones - In order not to iterate endlessly over milestones we introduce a threshold of milestones that +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.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.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.
    • releaser.git.run-updated-samples - If true then will update samples and run the the build. Defaults to true.
    • releaser.git.update-documentation-repo - If true then will update documentation repository with the current URL. Defaults to true.
    • releaser.git.update-spring-guides - If true then will update Spring Guides with the current release train. Defaults to true.
    • releaser.git.update-spring-project - If true then will update Spring Project page with the current release train values. Defaults to true.
    • 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.
    • releaser.git.number-of-checked-milestones - In order not to iterate endlessly over milestones we introduce a threshold of milestones that we will go through to find the matching milestone. Defaults to 10.
    • releaser.maven.build-command - Command to be executed to build the project. Defaults to ./mvnw clean install -Pdocs.
    • releaser.maven.deploy-command - Command to be executed to deploy a built project". Defaults to ./mvnw deploy -DskipTests -Pfast.
    • releaser.maven.publish-docs-commands - Command to be executed to deploy a built project. If present {{version}} will be replaced by the proper version. Defaults to the standard Spring Cloud wget and execution of ghpages.
    • releaser.maven.system-properties - Additional system properties that should be passed to any commands. If present {{systemProps}} will be replaced by the contents of this property.
    • releaser.maven.wait-time-in-minutes - Max wait time in minutes for the process to finish. Defaults to 20.
    • releaser.gradle.gradle-props-substitution - a map containing a key which is a property key inside gradle.properties and a value of a project name. E.g. in gradle.properties you have foo=1.0.0.BUILD-SNAPSHOT and you would like spring-cloud-contract version to diff --git a/spring-cloud-release-tools.xml b/spring-cloud-release-tools.xml index e9d54652..a226ce16 100644 --- a/spring-cloud-release-tools.xml +++ b/spring-cloud-release-tools.xml @@ -344,6 +344,9 @@ train depends on projects that got already released. We default this list to
    • releaser.git.test-samples-project-branch - Branch to check out for test samples. Defaults to master. +releaser.git.run-updated-samples - If true then will update samples and run the the build. Defaults to true. + + releaser.git.update-documentation-repo - If true then will update documentation repository with the current URL. Defaults to true.