From a360d3469c51149b438dd39141c1fc9101833c50 Mon Sep 17 00:00:00 2001 From: buildmaster Date: Wed, 23 Jan 2019 12:54:23 +0000 Subject: [PATCH] Sync docs from master to gh-pages --- multi/multi__spring_cloud_release_tools.html | 2 +- multi/multi_spring-cloud-release-tools.html | 2 +- single/spring-cloud-release-tools.html | 2 +- spring-cloud-release-tools.html | 2 +- spring-cloud-release-tools.xml | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/multi/multi__spring_cloud_release_tools.html b/multi/multi__spring_cloud_release_tools.html index 220f9ee2..dfb2e2e5 100644 --- a/multi/multi__spring_cloud_release_tools.html +++ b/multi/multi__spring_cloud_release_tools.html @@ -1,6 +1,6 @@ - 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 + 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?

1.1.1 Single project

For a single project

  • Clones the Spring Cloud Release project and picks all versions (Boot + Cloud projects)

  • Modifies the project versions with values from a BOM (e.g. for Spring Cloud it’s Spring Cloud 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)
[Important]Important

Starting with version that does Sagan integration, you MUST pass the OAuth token, otherwise the application will fail to start

After project release

1.1.2 Meta-release

  • Uses the fixed versions to clone and check out each project (e.g. spring-cloud-sleuth: 2.1.0.RELEASE)

  • From the version analyzes the branch and checks it out. E.g.

    • for spring-cloud-release’s `Finchley.RELEASE version will resolve either Finchley branch or will fallback to master if there’s no Finchley branch.
    • for spring-cloud-sleuth’s `2.1.0.RELEASE version will resolve 2.1.x branch
  • Performs the release tasks per each project
  • Performs the post release tasks at the end of the release
  • Will update and run smoke test samples (for Spring Cloud it will be https://github.com/spring-cloud/spring-cloud-core-tests)
  • Will clone provided test samples and will update all versions to the latest ones
  • Will clone the release train wiki and update it with the latest release versions (for Spring Cloud it will be https://github.com/spring-projects/spring-cloud.wiki.git)
[Important]Important

For the meta-releaser to work we assume that the path to the custom configuration file for each project is always config/releaser.yml.

1.2 What should I do first?

Members of the Spring Cloud Team typically use this tool as follows. They first diff --git a/multi/multi_spring-cloud-release-tools.html b/multi/multi_spring-cloud-release-tools.html index 6d0b5b96..a5ca7a5a 100644 --- a/multi/multi_spring-cloud-release-tools.html +++ b/multi/multi_spring-cloud-release-tools.html @@ -1,3 +1,3 @@ - Spring Cloud Release Tools

Spring Cloud Release Tools
   Next

Spring Cloud Release Tools

Table of Contents

1. Spring Cloud Release Tools
1.1. What does it do?
1.1.1. Single project
1.1.2. Meta-release
1.2. What should I do first?
1.3. How to run it (interactive mode)
1.4. How to run it (automatic mode)
1.5. How to run meta-release (automatic-mode)
1.6. Project options
1.7. Examples
1.7.1. Keeping configuration in the project
1.7.2. Specifying A Branch
1.7.3. Using Environment Variables
1.8. FAQ
1.8.1. JSchException: Auth fail
   Next
   1. Spring Cloud Release Tools
\ No newline at end of file + Spring Cloud Release Tools
Spring Cloud Release Tools
   Next

Spring Cloud Release Tools

Table of Contents

1. Spring Cloud Release Tools
1.1. What does it do?
1.1.1. Single project
1.1.2. Meta-release
1.2. What should I do first?
1.3. How to run it (interactive mode)
1.4. How to run it (automatic mode)
1.5. How to run meta-release (automatic-mode)
1.6. Project options
1.7. Examples
1.7.1. Keeping configuration in the project
1.7.2. Specifying A Branch
1.7.3. Using Environment Variables
1.8. FAQ
1.8.1. JSchException: Auth fail
   Next
   1. Spring Cloud Release Tools
\ No newline at end of file diff --git a/single/spring-cloud-release-tools.html b/single/spring-cloud-release-tools.html index ad2730b0..b3540412 100644 --- a/single/spring-cloud-release-tools.html +++ b/single/spring-cloud-release-tools.html @@ -1,6 +1,6 @@ - Spring Cloud Release Tools

Spring Cloud Release Tools

Table of Contents

1. Spring Cloud Release Tools
1.1. What does it do?
1.1.1. Single project
1.1.2. Meta-release
1.2. What should I do first?
1.3. How to run it (interactive mode)
1.4. How to run it (automatic mode)
1.5. How to run meta-release (automatic-mode)
1.6. Project options
1.7. Examples
1.7.1. Keeping configuration in the project
1.7.2. Specifying A Branch
1.7.3. Using Environment Variables
1.8. FAQ
1.8.1. JSchException: Auth fail

1. Spring Cloud Release Tools

Spring Cloud projects reuse the same pattern of building and deploying the applications. That’s + Spring Cloud Release Tools

Spring Cloud Release Tools

Table of Contents

1. Spring Cloud Release Tools
1.1. What does it do?
1.1.1. Single project
1.1.2. Meta-release
1.2. What should I do first?
1.3. How to run it (interactive mode)
1.4. How to run it (automatic mode)
1.5. How to run meta-release (automatic-mode)
1.6. Project options
1.7. Examples
1.7.1. Keeping configuration in the project
1.7.2. Specifying A Branch
1.7.3. Using Environment Variables
1.8. FAQ
1.8.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?

1.1.1 Single project

For a single project

  • Clones the Spring Cloud Release project and picks all versions (Boot + Cloud projects)

  • Modifies the project versions with values from a BOM (e.g. for Spring Cloud it’s Spring Cloud 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)
[Important]Important

Starting with version that does Sagan integration, you MUST pass the OAuth token, otherwise the application will fail to start

After project release

1.1.2 Meta-release

  • Uses the fixed versions to clone and check out each project (e.g. spring-cloud-sleuth: 2.1.0.RELEASE)

  • From the version analyzes the branch and checks it out. E.g.

    • for spring-cloud-release’s `Finchley.RELEASE version will resolve either Finchley branch or will fallback to master if there’s no Finchley branch.
    • for spring-cloud-sleuth’s `2.1.0.RELEASE version will resolve 2.1.x branch
  • Performs the release tasks per each project
  • Performs the post release tasks at the end of the release
  • Will update and run smoke test samples (for Spring Cloud it will be https://github.com/spring-cloud/spring-cloud-core-tests)
  • Will clone provided test samples and will update all versions to the latest ones
  • Will clone the release train wiki and update it with the latest release versions (for Spring Cloud it will be https://github.com/spring-projects/spring-cloud.wiki.git)
[Important]Important

For the meta-releaser to work we assume that the path to the custom configuration file for each project is always config/releaser.yml.

1.2 What should I do first?

Members of the Spring Cloud Team typically use this tool as follows. They first diff --git a/spring-cloud-release-tools.html b/spring-cloud-release-tools.html index 703312fe..2df45919 100644 --- a/spring-cloud-release-tools.html +++ b/spring-cloud-release-tools.html @@ -4,7 +4,7 @@ - + spring-cloud-release-tools