SpringCloud/spring-cloud-release-tools
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

All post release tasks are opt in; fixes gh-176

Browse Source
This commit is contained in:
Marcin Grzejszczak
2019-11-22 20:26:38 +01:00
parent 5b23bdb399
commit cdc1605ef5
12 changed files with 113 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
docs/src/main/asciidoc/_configprops.adoc
View File

@@ -1,11 +1,11 @@
|===
|Name | Default | Description
|releaser.bash.build-command | echo "{{systemProps}}" | Command to be executed to build the project.
|releaser.bash.deploy-command | echo "{{systemProps}}" | Command to be executed to deploy a built project.
|releaser.bash.deploy-guides-command | echo "{{systemProps}}" | Command to be executed to build and deploy guides project only.
|releaser.bash.build-command | echo "{{systemProps}}" | Command to be executed to build the project. If present "{{version}}" will be replaced by the provided version. "{{nextVersion}}" with the bumped snapshot version and "{{oldVersion}}" with the version before version updating.
|releaser.bash.deploy-command | echo "{{systemProps}}" | Command to be executed to deploy a built project. If present "{{version}}" will be replaced by the provided version. "{{nextVersion}}" with the bumped snapshot version and "{{oldVersion}}" with the version before version updating.
|releaser.bash.deploy-guides-command | echo "{{systemProps}}" | Command to be executed to build and deploy guides project only. If present "{{version}}" will be replaced by the provided version. "{{nextVersion}}" with the bumped snapshot version and "{{oldVersion}}" with the version before version updating.
|releaser.bash.generate-release-train-docs-command | echo "{{version}}" | Command to be executed to generate release train documentation.
|releaser.bash.publish-docs-commands | [mkdir -p target, echo "{{version}}"] | Command to be executed to publish documentation. If present "{{version}}" will be replaced by the provided version.
|releaser.bash.publish-docs-commands | [mkdir -p target, echo "{{version}}"] | Command to be executed to publish documentation. If present "{{version}}" will be replaced by the provided version. "{{nextVersion}}" with the bumped snapshot version and "{{oldVersion}}" with the version before version updating.
|releaser.bash.system-properties | | Additional system properties that should be passed to the build / deploy commands. If present in other commands "{{systemProps}}" will be substituted with this property.
|releaser.bash.wait-time-in-minutes | 20 | Max wait time in minutes for the process to finish.
|releaser.fixed-versions | | Project name to its version - overrides all versions retrieved from a release train repository like Spring Cloud Release.
@@ -22,31 +22,32 @@
|releaser.git.release-train-docs-url | https://github.com/spring-cloud-samples/scripts | URL to the release train documentation.
|releaser.git.release-train-wiki-page-prefix | Spring-Cloud | Page prefix for the release train wiki. E.g. for [Spring-Cloud-Finchley-Release-Notes] it would be [Spring-Cloud].
|releaser.git.release-train-wiki-url | https://github.com/spring-projects/spring-cloud.wiki | URL to the release train wiki.
|releaser.git.run-updated-samples | true | If set to {@code false}, will not update the test samples.
|releaser.git.run-updated-samples | false | If set to {@code false}, will not update the test samples.
|releaser.git.spring-project-branch | gh-pages | Branch to check out for the release train project.
|releaser.git.spring-project-url | https://github.com/spring-projects/spring-cloud | URL to the release train project page repository.
|releaser.git.test-samples-branch | master | Branch to check out for the test samples.
|releaser.git.test-samples-project-url | https://github.com/spring-cloud/spring-cloud-core-tests | URL to test samples.
|releaser.git.update-all-test-samples | true | If set to {@code false}, will not clone and update the samples for all projects.
|releaser.git.update-documentation-repo | true | If {@code false}, will not update the documentation repository.
|releaser.git.update-release-train-docs | true | If set to {@code false}, will not update the release train docs.
|releaser.git.update-release-train-wiki | true | If set to {@code false}, will not clone and update the release train wiki.
|releaser.git.update-spring-guides | true | If set to {@code false}, will not update Spring Guides for a release train.
|releaser.git.update-spring-project | true | If set to {@code false}, will not update the Spring Project for a release train. E.g. for Spring Cloud will not update https://cloud.spring.io .
|releaser.git.update-start-spring-io | true | If set to {@code false}, will not update start.spring.io for a release train.
|releaser.git.update-all-test-samples | false | If set to {@code false}, will not clone and update the samples for all projects.
|releaser.git.update-documentation-repo | false | If {@code false}, will not update the documentation repository.
|releaser.git.update-github-milestones | false | If set to {@code false}, will not update Github milestones.
|releaser.git.update-release-train-docs | false | If set to {@code false}, will not update the release train docs.
|releaser.git.update-release-train-wiki | false | If set to {@code false}, will not clone and update the release train wiki.
|releaser.git.update-spring-guides | false | If set to {@code false}, will not update Spring Guides for a release train.
|releaser.git.update-spring-project | false | If set to {@code false}, will not update the Spring Project for a release train. E.g. for Spring Cloud will not update https://cloud.spring.io .
|releaser.git.update-start-spring-io | false | If set to {@code false}, will not update start.spring.io for a release train.
|releaser.git.username | | Optional Git username. If not passed keys will be used for authentication.
|releaser.gradle.build-command | ./gradlew clean build publishToMavenLocal {{systemProps}} | Command to be executed to build the project.
|releaser.gradle.deploy-command | ./gradlew clean build publish {{systemProps}} | Command to be executed to deploy a built project.
|releaser.gradle.deploy-guides-command | ./gradlew clean build deployGuides {{systemProps}} | Command to be executed to build and deploy guides project only.
|releaser.gradle.build-command | ./gradlew clean build publishToMavenLocal --console=plain -PnextVersion={{nextVersion}} -PoldVersion={{oldVersion}} -PcurrentVersion={{version}} {{systemProps}} | Command to be executed to build the project If present "{{version}}" will be replaced by the provided version. "{{nextVersion}}" with the bumped snapshot version and "{{oldVersion}}" with the version before version updating.
|releaser.gradle.deploy-command | ./gradlew publish --console=plain -PnextVersion={{nextVersion}} -PoldVersion={{oldVersion}} -PcurrentVersion={{version}} {{systemProps}} | Command to be executed to deploy a built project.
|releaser.gradle.deploy-guides-command | ./gradlew clean build deployGuides --console=plain -PnextVersion={{nextVersion}} -PoldVersion={{oldVersion}} -PcurrentVersion={{version}} {{systemProps}} | Command to be executed to build and deploy guides project only.
|releaser.gradle.generate-release-train-docs-command | echo 'TODO' | Command to be executed to generate release train documentation.
|releaser.gradle.gradle-props-substitution | | A mapping that should be applied to {@code gradle.properties} in order to perform a substitution of properties. The mapping is from a property inside {@code gradle.properties} to the projects name. Example. In {@code gradle.properties} you have {@code verifierVersion=1.0.0} . You want this property to get updated with the value of {@code spring-cloud-contract} version. Then it's enough to do the mapping like this for this Releaser's property: {@code verifierVersion=spring-cloud-contract}.
|releaser.gradle.ignored-gradle-regex | | List of regular expressions of ignored gradle props. Defaults to test projects and samples.
|releaser.gradle.publish-docs-commands | [echo 'TODO'] | Command to be executed to publish documentation. If present "{{version}}" will be replaced by the provided version.
|releaser.gradle.system-properties | | Additional system properties that should be passed to the build / deploy commands. If present in other commands "{{systemProps}}" will be substituted with this property.
|releaser.gradle.wait-time-in-minutes | 20 | Max wait time in minutes for the process to finish.
|releaser.maven.build-command | ./mvnw clean install -B -Pdocs {{systemProps}} | Command to be executed to build the project.
|releaser.maven.deploy-command | ./mvnw deploy -DskipTests -B -Pfast,deploy {{systemProps}} | Command to be executed to deploy a built project.
|releaser.maven.deploy-guides-command | ./mvnw clean verify deploy -B -Pguides,integration -pl guides {{systemProps}} | Command to be executed to build and deploy guides project only.
|releaser.maven.build-command | ./mvnw clean install -B -Pdocs {{systemProps}} | Command to be executed to build the project. If present "{{version}}" will be replaced by the provided version. "{{nextVersion}}" with the bumped snapshot version and "{{oldVersion}}" with the version before version updating.
|releaser.maven.deploy-command | ./mvnw deploy -DskipTests -B -Pfast,deploy {{systemProps}} | Command to be executed to deploy a built project. If present "{{version}}" will be replaced by the provided version. "{{nextVersion}}" with the bumped snapshot version and "{{oldVersion}}" with the version before version updating.
|releaser.maven.deploy-guides-command | ./mvnw clean verify deploy -B -Pguides,integration -pl guides {{systemProps}} | Command to be executed to build and deploy guides project only. If present "{{version}}" will be replaced by the provided version. "{{nextVersion}}" with the bumped snapshot version and "{{oldVersion}}" with the version before version updating.
|releaser.maven.generate-release-train-docs-command | bash release_train.sh --retrieveversions --version {{version}} --ghpages --auto | Command to be executed to generate release train documentation.
|releaser.maven.publish-docs-commands | [mkdir -p target, wget https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/docs/src/main/asciidoc/ghpages.sh -O target/gh-pages.sh, chmod +x target/gh-pages.sh, ./target/gh-pages.sh -v {{version}} -c] | Command to be executed to publish documentation. If present "{{version}}" will be replaced by the provided version.
|releaser.maven.system-properties | | Additional system properties that should be passed to the build / deploy commands. If present in other commands "{{systemProps}}" will be substituted with this property.
@@ -66,7 +67,7 @@
|releaser.sagan.boot-section-file-name | sagan-boot.adoc | Name of the ascii doc file with boot part of this project's Sagan project page. Linked with {@link this#docsAdocsFile}.
|releaser.sagan.docs-adocs-file | docs/src/main/asciidoc | Folder with asciidoctor files for docs.
|releaser.sagan.index-section-file-name | sagan-index.adoc | Name of the ascii doc file with core part of this project's Sagan project page. Linked with {@link this#docsAdocsFile}.
|releaser.sagan.update-sagan | true | If set to {@code false} will not update Sagan.
|releaser.sagan.update-sagan | false | If set to {@code false} will not update Sagan.
|releaser.template.template-folder | cloud | Folder in which blog, email etc. templates are stored.
|releaser.versions.all-versions-file-url | https://raw.githubusercontent.com/spring-io/start.spring.io/master/start-site/src/main/resources/application.yml | Url to a file containing all the versions. Defaults to YAML from start.spring.io.
|releaser.versions.bom-name | spring-cloud | Name in the YAML from initilizr for BOM mappings.