From ffaf16e2406ec15b6fd5aa456b1619a36a6bdf6e Mon Sep 17 00:00:00 2001 From: buildmaster Date: Tue, 16 Oct 2018 17:01:17 +0000 Subject: [PATCH] Sync docs from master to gh-pages --- multi/multi__spring_cloud_release_tools.html | 4 ++-- single/spring-cloud-release-tools.html | 4 ++-- spring-cloud-release-tools.xml | 9 +++++++++ 3 files changed, 13 insertions(+), 4 deletions(-) diff --git a/multi/multi__spring_cloud_release_tools.html b/multi/multi__spring_cloud_release_tools.html index 5ffd2528..06c30c64 100644 --- a/multi/multi__spring_cloud_release_tools.html +++ b/multi/multi__spring_cloud_release_tools.html @@ -115,13 +115,13 @@ 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.release-train-project-name - Name of the project that represents the BOM of the release train. Defaults to spring-cloud-release
  • 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].
  • 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.spring-cloud-release-git-url - URL to Spring Cloud Release Git repository. Defaults to 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.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].
  • 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.spring-cloud-release-git-url - URL to Spring Cloud Release Git repository. Defaults to 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.update-spring-guides - If true then will update Spring Guides with the current release train. 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 be set there. Just provide a mapping for the gradle-props-substition looking like this foo=spring-cloud-contract and the result (e.g for sc-contract version 2.0.0.RELEASE) will be an updated gradle.properties with entry foo=2.0.0.RELEASE
  • releaser.pom.branch - Which branch of Spring Cloud Release should be checked out. Defaults to "master",
  • releaser.pom.ignored-pom-regex - List of regular expressions of ignored poms. Defaults to test projects and samples. -Example: "--releaser.pom.ignored-pom-regex=".*\\.git/.*$,.{asterisk}spring-cloud-contract-maven-plugin/src/test/projects/.*$,.*spring-cloud-contract-maven-plugin/target/.*$,.*samples/standalone/[a-z]+/.*$"
  • releaser.working-dir - By default Releaser assumes running the program from the current working directory.
    • [Tip]Tip

    You can pass the options either via system properties or via application arguments. +Example: "--releaser.pom.ignored-pom-regex=".*\\.git/.*$,.{asterisk}spring-cloud-contract-maven-plugin/src/test/projects/.*$,.*spring-cloud-contract-maven-plugin/target/.*$,.*samples/standalone/[a-z]+/.*$"

  • releaser.working-dir - By default Releaser assumes running the program from the current working directory.
  • releaser.template.template-folder - Tells which subfolder with templates to pick for blog, email etc. generation. Defaults to cloud
    • [Tip]Tip

    You can pass the options either via system properties or via application arguments. Example for system properties: java -Dreleaser.pom.branch=Camden.SR6 -jar target/spring-cloud-release-tools-spring-1.0.0.M1.jar Example for application arguments: java -jar target/spring-cloud-release-tools-spring-1.0.0.M1.jar --releaser.pom.branch=Camden.SR6

    [Important]Important

    For the GA release to be successful, it’s important that if the build / deploy command run a script (e.g. scripts/foo.sh) then inside foo.sh if you call a Maven build ./mvnw clean install diff --git a/single/spring-cloud-release-tools.html b/single/spring-cloud-release-tools.html index e3c7cfab..745da13b 100644 --- a/single/spring-cloud-release-tools.html +++ b/single/spring-cloud-release-tools.html @@ -115,13 +115,13 @@ 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.release-train-project-name - Name of the project that represents the BOM of the release train. Defaults to spring-cloud-release
  • 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].
  • 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.spring-cloud-release-git-url - URL to Spring Cloud Release Git repository. Defaults to 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.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].
  • 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.spring-cloud-release-git-url - URL to Spring Cloud Release Git repository. Defaults to 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.update-spring-guides - If true then will update Spring Guides with the current release train. 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 be set there. Just provide a mapping for the gradle-props-substition looking like this foo=spring-cloud-contract and the result (e.g for sc-contract version 2.0.0.RELEASE) will be an updated gradle.properties with entry foo=2.0.0.RELEASE
  • releaser.pom.branch - Which branch of Spring Cloud Release should be checked out. Defaults to "master",
  • releaser.pom.ignored-pom-regex - List of regular expressions of ignored poms. Defaults to test projects and samples. -Example: "--releaser.pom.ignored-pom-regex=".*\\.git/.*$,.{asterisk}spring-cloud-contract-maven-plugin/src/test/projects/.*$,.*spring-cloud-contract-maven-plugin/target/.*$,.*samples/standalone/[a-z]+/.*$"
  • releaser.working-dir - By default Releaser assumes running the program from the current working directory.
    • [Tip]Tip

    You can pass the options either via system properties or via application arguments. +Example: "--releaser.pom.ignored-pom-regex=".*\\.git/.*$,.{asterisk}spring-cloud-contract-maven-plugin/src/test/projects/.*$,.*spring-cloud-contract-maven-plugin/target/.*$,.*samples/standalone/[a-z]+/.*$"

  • releaser.working-dir - By default Releaser assumes running the program from the current working directory.
  • releaser.template.template-folder - Tells which subfolder with templates to pick for blog, email etc. generation. Defaults to cloud
    • [Tip]Tip

    You can pass the options either via system properties or via application arguments. Example for system properties: java -Dreleaser.pom.branch=Camden.SR6 -jar target/spring-cloud-release-tools-spring-1.0.0.M1.jar Example for application arguments: java -jar target/spring-cloud-release-tools-spring-1.0.0.M1.jar --releaser.pom.branch=Camden.SR6

    [Important]Important

    For the GA release to be successful, it’s important that if the build / deploy command run a script (e.g. scripts/foo.sh) then inside foo.sh if you call a Maven build ./mvnw clean install diff --git a/spring-cloud-release-tools.xml b/spring-cloud-release-tools.xml index b23a63b3..3b58dd3b 100644 --- a/spring-cloud-release-tools.xml +++ b/spring-cloud-release-tools.xml @@ -323,6 +323,12 @@ train depends on projects that got already released. We default this list to

  • 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.update-spring-guides - If true then will update Spring Guides with the current release train. Defaults to true + + releaser.git.oauth-token - GitHub OAuth token to be used to interact with GitHub repo. @@ -367,6 +373,9 @@ Example: "--releaser.pom.ignored-pom-regex=".*\\.git/.*$,.{asterisk}spr releaser.working-dir - By default Releaser assumes running the program from the current working directory. + +releaser.template.template-folder - Tells which subfolder with templates to pick for blog, email etc. generation. Defaults to cloud + You can pass the options either via system properties or via application arguments.