Updated the docs
This commit is contained in:
Marcin Grzejszczak
22
docs/pom.xml
22
docs/pom.xml
@@ -13,7 +13,25 @@
|
||||
<docs.main>spring-cloud-release-tools</docs.main>
|
||||
<main.basedir>${basedir}/..</main.basedir>
|
||||
<maven.plugin.plugin.version>3.4</maven.plugin.plugin.version>
|
||||
<configprops.inclusionPattern>releaser.*</configprops.inclusionPattern>
|
||||
</properties>
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-info</artifactId>
|
||||
<version>${project.version}</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>${project.groupId}</groupId>
|
||||
<artifactId>spring-cloud-release-tools-core</artifactId>
|
||||
<version>${project.version}</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>${project.groupId}</groupId>
|
||||
<artifactId>spring-cloud-release-tools-spring</artifactId>
|
||||
<version>${project.version}</version>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
<build>
|
||||
<plugins>
|
||||
<plugin>
|
||||
@@ -60,6 +78,10 @@
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.codehaus.mojo</groupId>
|
||||
<artifactId>exec-maven-plugin</artifactId>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.asciidoctor</groupId>
|
||||
<artifactId>asciidoctor-maven-plugin</artifactId>
|
||||
|
||||
75
docs/src/main/asciidoc/_configprops.adoc
Normal file
75
docs/src/main/asciidoc/_configprops.adoc
Normal file
@@ -0,0 +1,75 @@
|
||||
|===
|
||||
|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.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.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.
|
||||
|releaser.git.all-test-sample-urls | | Project to urls mapping. For each project will clone the test project and will update its versions.
|
||||
|releaser.git.clone-destination-dir | | Where should the release train repo get cloned to. If {@code null} defaults to a temporary directory.
|
||||
|releaser.git.documentation-branch | gh-pages | Branch to check out for the documentation project.
|
||||
|releaser.git.documentation-url | https://github.com/spring-cloud/spring-cloud-static | URL to the documentation Git repository.
|
||||
|releaser.git.fetch-versions-from-git | true | If {@code true} then should fill the map of versions from Git. If {@code false} then picks fixed versions.
|
||||
|releaser.git.number-of-checked-milestones | 50 | In order not to iterate endlessly over milestones we introduce a threshold of milestones that we will go through to find the matching milestone.
|
||||
|releaser.git.oauth-token | | GitHub OAuth token to be used to interact with GitHub repo.
|
||||
|releaser.git.password | | Optional Git password. If not passed keys will be used for authentication.
|
||||
|releaser.git.release-train-bom-url | https://github.com/spring-cloud/spring-cloud-release | URL to a release train repository.
|
||||
|releaser.git.release-train-docs-branch | master | Branch to check out for the release train docs.
|
||||
|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.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.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.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.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.
|
||||
|releaser.maven.wait-time-in-minutes | 20 | Max wait time in minutes for the process to finish.
|
||||
|releaser.meta-release.enabled | false | Are we releasing the whole suite of apps or only one?
|
||||
|releaser.meta-release.git-org-url | https://github.com/spring-cloud | The URL of the Git organization. We'll append each project's name to it.
|
||||
|releaser.meta-release.projects-to-skip | | Names of projects to skip deployment for meta-release.
|
||||
|releaser.meta-release.release-train-dependency-names | | All the names of dependencies that should be updated with the release train project version.
|
||||
|releaser.meta-release.release-train-project-name | spring-cloud-release | Name of the release train project.
|
||||
|releaser.pom.bom-version-pattern | ^(spring-cloud-.*)\.version$ | The pattern to match a version property in a BOM.
|
||||
|releaser.pom.branch | master | Which branch of release train BOM should be checked out. Defaults to {@code master}.
|
||||
|releaser.pom.ignored-pom-regex | | List of regular expressions of ignored poms. Defaults to test projects and samples.
|
||||
|releaser.pom.pom-with-boot-starter-parent | spring-cloud-starter-parent/pom.xml | Subfolder of the pom that contains the {@code spring-boot-starer-parent} dependency.
|
||||
|releaser.pom.this-train-bom | spring-cloud-dependencies/pom.xml | Subfolder of the pom that contains the versions for the release train.
|
||||
|releaser.post-release-tasks-only | false | If set to {@code true} will run only post release tasks.
|
||||
|releaser.sagan.base-url | https://spring.io | URL to the Sagan API.
|
||||
|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.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.
|
||||
|releaser.working-dir | | By default Releaser assumes running the program from the current working directory. If you want to change this behaviour - just change this value.
|
||||
|
||||
|===
|
||||
@@ -260,74 +260,9 @@ or build only tasks with names `spring-cloud-build,spring-cloud-sleuth`.
|
||||
|
||||
=== 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. Example `--releaser.fixed-versions[spring-cloud-cli]=1.0.0.RELEASE`.
|
||||
Use these properties to provide versions for the meta release.
|
||||
Below you can find a table with all the releaser options.
|
||||
|
||||
- `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]`.
|
||||
- `releaser.git.update-documentation-repo` - If `true` then will update documentation repository with the `current` URL. Defaults to `true`.
|
||||
- `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.update-spring-project` - If `true` then will update Project Sagan with the current release train values. Defaults to `true`.
|
||||
- `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.release-train-wiki-url` - URL to the project's release train wiki page. Defaults to `https://github.com/spring-projects/spring-cloud.wiki.git`.
|
||||
- `releaser.git.update-release-train-wiki` - If `true` then will update the release train wiki page with the current release train values. Defaults to `true`.
|
||||
- `releaser.git.run-updated-samples` - If `true` then will update samples and run the the build. Defaults to `true`.
|
||||
- `releaser.git.all-test-samples-urls` - URLs to the test samples to be cloned and updated with proper snapshot versions.
|
||||
E.g. `"--releaser.git.all-test-samples-urls[spring-cloud-sleuth]=https://github.com/spring-cloud-samples/sleuth-issues/,https://github.com/spring-cloud-samples/sleuth-documentation-apps/"`.
|
||||
Defaults to Sleuth and Contract samples.
|
||||
- `releaser.git.update-all-test-samples` - If `true` then will update samples with bumped snapshots after release. Defaults to `true`.
|
||||
- `releaser.git.release-train-docs-url` - URL to the release train documentation. Defaults to `https://github.com/spring-cloud-sample/scripts`.
|
||||
- `releaser.git.release-train-docs-branch` - Branch to check out for release train documentation. Defaults to `master`.
|
||||
- `releaser.git.update-release-train-docs` - If `true` then will update the release train documentation project and run the generation. 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-start-spring-io` - If `true` then will update start.spring.io with the current release train. Defaults to `true`.
|
||||
|
||||
The following properties are used for both meta release and a release of an individual module.
|
||||
|
||||
- `releaser.post-release-tasks-only` - If set to `true` will run only post release tasks. 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.release-train-dependency-names` - Names of the projects that should be updated with the version of the release train. Defaults to `[spring-cloud, spring-cloud-dependencies, spring-cloud-starter]`.
|
||||
- `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.sagan.update-sagan` - If `true` then will update project sagan with information about this project. Defaults to `true`.
|
||||
|
||||
- `releaser.sagan.docs-adocs-file` - Folder with asciidoctor files for docs. Defaults to `docs/src/main/asciidoc`.
|
||||
- `releaser.sagan.index-section-file-name` - Name of the ascii doc file with core part of this project's Sagan project page. Will search under `releaser.sagan.docs-adocs-file` folder. Defaults to `sagan-index.adoc`.
|
||||
- `releaser.sagan.boot-section-file-name` - Name of the ascii doc file with boot part of this project's Sagan project page. Will search under `releaser.sagan.docs-adocs-file` folder. Defaults to `sagan-boot.adoc`.
|
||||
- `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.pom-with-boot-starter-parent` - What is the location of the `pom.xml` that contains the `spring-boot-starter-parent` as its parent pom. Defaults to `spring-cloud-starter-parent/pom.xml`.
|
||||
- `releaser.pom.this-train-bom` - What is the location of the `pom.xml` that contains all the versions for the release train. Defaults to `spring-cloud-dependencies/pom.xml`.
|
||||
- `releaser.pom.bom-version-pattern` - Regular expression that will match the versions of projects in the BOM pom.xml. Defaults to `^(spring-cloud-.*)\.version$`.
|
||||
- `releaser.pom.ignored-pom-regex` - List of regular expressions of ignored poms. Defaults to test projects and samples.
|
||||
Example: `"--releaser.pom.ignored-pom-regex=".{asterisk}\\.git/.{asterisk}$,.\{asterisk}spring-cloud-contract-maven-plugin/src/test/projects/.{asterisk}$,.{asterisk}spring-cloud-contract-maven-plugin/target/.{asterisk}$,.{asterisk}samples/standalone/[a-z]+/.{asterisk}$"`.
|
||||
- `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`.
|
||||
- `releaser.versions.all-versions-file-url` - Url to a file containing all the versions. Defaults to YAML from start.spring.io.
|
||||
- `releaser.versions.bom-name` - Name in the YAML from initilizr for BOM mappings. Defaults to `spring-cloud`.
|
||||
include::_configprops.adoc[]
|
||||
|
||||
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`
|
||||
|
||||
Reference in New Issue
Block a user