From 7a13cf08bffb38850525635de6bcf99f1a97cb42 Mon Sep 17 00:00:00 2001 From: buildmaster Date: Wed, 6 Sep 2017 11:15:55 +0000 Subject: [PATCH] Sync docs from master to gh-pages --- multi/multi__spring_cloud_release_tools.html | 5 +++-- single/spring-cloud-release-tools.html | 5 +++-- spring-cloud-release-tools.xml | 9 ++++++++- 3 files changed, 14 insertions(+), 5 deletions(-) diff --git a/multi/multi__spring_cloud_release_tools.html b/multi/multi__spring_cloud_release_tools.html index 53f30e83..fcf76465 100644 --- a/multi/multi__spring_cloud_release_tools.html +++ b/multi/multi__spring_cloud_release_tools.html @@ -1,7 +1,7 @@ 1. Spring Cloud Release Tools
1. Spring Cloud Release Tools
Prev   

1. Spring Cloud Release Tools

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.

1.1 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

    • throws an exception when we bump versions to release and there’s a SNAPSHOT version referenced in the POM

  • Performs the build and checks if the docs modules have properly created the documentation

    • throws an exception when in the docs module there’s an unresolved tag in any HTML file
  • 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 RELEASE VERSIONS)
  • Closes the milestone on Github (e.g. v1.0.1.RELEASE) (ONLY FOR NON-SNAPSHOT VERSIONS)
  • Generates an email template under target/email.txt (ONLY FOR NON-SNAPSHOT VERSIONS)
  • Generates a blog template under target/blog.md (ONLY FOR NON-SNAPSHOT VERSIONS)
  • Generates a tweet template under target/tweet.txt (ONLY FOR NON-SNAPSHOT VERSIONS)

1.2 How to run it

Members of the Spring Cloud Team typically use this tool as follows. They first +why this tool makes it easy to automate the release / dependency update process of our applications.

1.1 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

    • throws an exception when we bump versions to release and there’s a SNAPSHOT version referenced in the POM

  • Performs the build and checks if the docs modules have properly created the documentation

    • throws an exception when in the docs module there’s an unresolved tag in any HTML file
  • 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 RELEASE VERSIONS)
  • Closes the milestone on Github (e.g. v1.0.1.RELEASE) (ONLY FOR NON-SNAPSHOT VERSIONS)
  • Generates an email template under target/email.txt (ONLY FOR NON-SNAPSHOT VERSIONS)
  • Generates a blog template under target/blog.md (ONLY FOR NON-SNAPSHOT VERSIONS)
  • Generates a tweet template under target/tweet.txt (ONLY FOR NON-SNAPSHOT VERSIONS)
  • Generates a release notes template under target/notes.md (ONLY FOR NON-SNAPSHOT VERSIONS)

1.2 How to run it

Members of the Spring Cloud Team typically use this tool as follows. They first clone the releaser locally and build the jar manually

$ git clone git@github.com:spring-cloud/spring-cloud-release-tools.git
 $ cd spring-cloud-release-tools
 $ ./mvnw clean install

Go to your project (e.g. Spring Cloud Sleuth)

$ git clone git@github.com:spring-cloud/spring-cloud-sleuth.git
@@ -24,7 +24,8 @@ $ java -jar ~/repo/spring-cloud-release-tools/spring-cloud-release-tools-spring/
 
 
 You can press 'q' to quit

Just pick a number and continue! Pick either a full release or single steps.

[Tip]Tip

Read before picking a number cause it might have changed between tool releases ;)

1.3 Project options

  • releaser.fixed-versions - A String to String mapping of manually set versions. E.g. "spring-cloud-cli" → "1.0.0.RELEASE" will set -the spring-cloud-cli.version to 1.0.0.RELEASE regardless of what was set in spring-cloud-release project
  • 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.oauth-token - GitHub OAuth token to be used to interact with GitHub repo.
  • 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. +the spring-cloud-cli.version to 1.0.0.RELEASE regardless of what was set in spring-cloud-release project
  • 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.oauth-token - GitHub OAuth token to be used to interact with GitHub repo.
  • 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.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 diff --git a/single/spring-cloud-release-tools.html b/single/spring-cloud-release-tools.html index 1dfbf4ec..6cdc78a8 100644 --- a/single/spring-cloud-release-tools.html +++ b/single/spring-cloud-release-tools.html @@ -1,7 +1,7 @@ Spring Cloud Release Tools

    Spring Cloud Release Tools

    Table of Contents

    1. Spring Cloud Release Tools
    1.1. What does it do?
    1.2. How to run it
    1.3. Project options
    1.4. Examples
    1.4.1. Keeping configuration in the project
    1.4.2. Specifying A Branch
    1.4.3. Using Environment Variables
    1.5. FAQ
    1.5.1. JSchException: Auth fail

    1. Spring Cloud Release Tools

    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.

    1.1 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

      • throws an exception when we bump versions to release and there’s a SNAPSHOT version referenced in the POM

    • Performs the build and checks if the docs modules have properly created the documentation

      • throws an exception when in the docs module there’s an unresolved tag in any HTML file
    • 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 RELEASE VERSIONS)
    • Closes the milestone on Github (e.g. v1.0.1.RELEASE) (ONLY FOR NON-SNAPSHOT VERSIONS)
    • Generates an email template under target/email.txt (ONLY FOR NON-SNAPSHOT VERSIONS)
    • Generates a blog template under target/blog.md (ONLY FOR NON-SNAPSHOT VERSIONS)
    • Generates a tweet template under target/tweet.txt (ONLY FOR NON-SNAPSHOT VERSIONS)

    1.2 How to run it

    Members of the Spring Cloud Team typically use this tool as follows. They first +why this tool makes it easy to automate the release / dependency update process of our applications.

    1.1 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

      • throws an exception when we bump versions to release and there’s a SNAPSHOT version referenced in the POM

    • Performs the build and checks if the docs modules have properly created the documentation

      • throws an exception when in the docs module there’s an unresolved tag in any HTML file
    • 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 RELEASE VERSIONS)
    • Closes the milestone on Github (e.g. v1.0.1.RELEASE) (ONLY FOR NON-SNAPSHOT VERSIONS)
    • Generates an email template under target/email.txt (ONLY FOR NON-SNAPSHOT VERSIONS)
    • Generates a blog template under target/blog.md (ONLY FOR NON-SNAPSHOT VERSIONS)
    • Generates a tweet template under target/tweet.txt (ONLY FOR NON-SNAPSHOT VERSIONS)
    • Generates a release notes template under target/notes.md (ONLY FOR NON-SNAPSHOT VERSIONS)

    1.2 How to run it

    Members of the Spring Cloud Team typically use this tool as follows. They first clone the releaser locally and build the jar manually

    $ git clone git@github.com:spring-cloud/spring-cloud-release-tools.git
 $ cd spring-cloud-release-tools
 $ ./mvnw clean install

    Go to your project (e.g. Spring Cloud Sleuth)

    $ git clone git@github.com:spring-cloud/spring-cloud-sleuth.git
@@ -24,7 +24,8 @@ $ java -jar ~/repo/spring-cloud-release-tools/spring-cloud-release-tools-spring/
 
 
 You can press 'q' to quit

    Just pick a number and continue! Pick either a full release or single steps.

    [Tip]Tip

    Read before picking a number cause it might have changed between tool releases ;)

    1.3 Project options

    • releaser.fixed-versions - A String to String mapping of manually set versions. E.g. "spring-cloud-cli" → "1.0.0.RELEASE" will set -the spring-cloud-cli.version to 1.0.0.RELEASE regardless of what was set in spring-cloud-release project
    • 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.oauth-token - GitHub OAuth token to be used to interact with GitHub repo.
    • 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. +the spring-cloud-cli.version to 1.0.0.RELEASE regardless of what was set in spring-cloud-release project
    • 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.oauth-token - GitHub OAuth token to be used to interact with GitHub repo.
    • 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.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 diff --git a/spring-cloud-release-tools.xml b/spring-cloud-release-tools.xml index 45d44880..2e16bc8b 100644 --- a/spring-cloud-release-tools.xml +++ b/spring-cloud-release-tools.xml @@ -4,7 +4,7 @@ Spring Cloud Release Tools -2017-08-31 +2017-09-06 Spring Cloud Release Tools @@ -59,6 +59,9 @@ why this tool makes it easy to automate the release / dependency update process Generates a tweet template under target/tweet.txt (ONLY FOR NON-SNAPSHOT VERSIONS) + +Generates a release notes template under target/notes.md (ONLY FOR NON-SNAPSHOT VERSIONS) +
      @@ -117,6 +120,10 @@ the spring-cloud-cli.version to 1.0.0.RELEASEreleaser.git.oauth-token - GitHub OAuth token to be used to interact with GitHub repo. +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