Compare commits

...
Author SHA1 Message Date
spring-builds 77f6c3a075 Bumping versions 2025-06-22 21:36:28 +00:00
spring-builds 978e805994 Bumping versions to 3.1.11-SNAPSHOT after release 2025-06-09 18:20:15 +00:00
spring-builds 44cfb04e40 Going back to snapshots 2025-06-09 18:20:14 +00:00
spring-builds bd88ec6600 Update SNAPSHOT to 3.1.10 2025-06-09 18:18:33 +00:00
Ryan Baxter f07fb662ce Upgrade gpg plugin version 2025-06-09 13:50:45 -04:00
buildmaster 6aaecc25b3 Bumping versions 2023-12-19 21:35:44 +00:00
Spencer Gibb bf86d8c42c Update master branch to 3.1.x 2023-12-19 10:39:52 -05:00
buildmaster a537984051 Bumping versions to 3.1.10-SNAPSHOT after release 2023-12-18 22:12:37 +00:00
buildmaster 692fdfa159 Going back to snapshots 2023-12-18 22:12:37 +00:00
buildmaster 8004f386bf Update SNAPSHOT to 3.1.9 2023-12-18 22:08:50 +00:00
Marcin Grzejszczak a010f184b8 Removed wrong extensions 2023-09-25 14:18:19 +02:00
Marcin Grzejszczak baca4d23cc Migrates away from spring-docs-resource to spring-asciidoctor-backend; fixes gh-242 2023-09-25 14:12:09 +02:00
buildmaster a237137ed4 Bumping versions to 3.1.9-SNAPSHOT after release 2023-06-29 10:28:09 +00:00
buildmaster 195ce4e753 Going back to snapshots 2023-06-29 10:28:09 +00:00
buildmaster 6a8dfa60d3 Update SNAPSHOT to 3.1.8 2023-06-29 10:26:50 +00:00
Marcin Grzejszczak a2e2ff90e2 Not building the docs for CI builds - changed the env var; fixes gh-239 2023-06-27 14:13:48 +02:00
Marcin Grzejszczak d7f3a8f35d Not building the docs for CI builds - we cant' fetch jars; fixes gh-239 2023-06-27 14:07:14 +02:00
Marcin Grzejszczak b52dff8956 Revert "Not building the docs for CI builds - we cant' fetch jars; fixes gh-239"
This reverts commit 4bea4c590f.
2023-06-27 13:43:19 +02:00
Marcin Grzejszczak 4bea4c590f Not building the docs for CI builds - we cant' fetch jars; fixes gh-239 2023-06-27 13:39:12 +02:00
Marcin Grzejszczak 8087edaf9a Unpacking docs resources only for non CI builds, fixed wrong env var derefernce; fixes gh-239 2023-06-27 12:48:21 +02:00
Marcin Grzejszczak 79ec1a0b58 Unpacking docs resources only for non CI builds; fixes gh-239 2023-06-27 12:29:41 +02:00
Marcin Grzejszczak 6f7f008710 Uses jar-with-deps for sc-build-docs; fixes gh-238 2023-06-26 14:40:37 +02:00
Marcin Grzejszczak 240995fa09 Created a separate task; related to gh-221 2023-05-04 17:12:35 +02:00
Marcin Grzejszczak 661a4ccb61 Don't fail on error; related to gh-221 2023-05-04 17:07:32 +02:00
Marcin Grzejszczak 983d743cd6 Adds a conditional on folder; related to gh-221 2023-05-04 17:03:02 +02:00
Marcin Grzejszczak 04b16bd386 Fixes htmlsingleadoc by copying the index file; gh-221 2023-05-04 16:44:58 +02:00
buildmaster c34d045a87 Bumping versions to 3.1.8-SNAPSHOT after release 2023-04-27 14:07:42 +00:00
buildmaster 5e60d0ba3b Going back to snapshots 2023-04-27 14:07:42 +00:00
buildmaster 754ac21e0c Update SNAPSHOT to 3.1.7 2023-04-27 14:06:04 +00:00
buildmaster 2742082c21 Bumping versions to 3.1.7-SNAPSHOT after release 2023-02-23 21:59:17 +00:00
buildmaster 4965414a99 Going back to snapshots 2023-02-23 21:59:17 +00:00
buildmaster 63c0f70252 Update SNAPSHOT to 3.1.6 2023-02-23 21:57:59 +00:00
Marcin Grzejszczak 4f137c8551 Parametrizes the gpg phase so that projects can opt out of it 2023-02-07 16:19:17 +01:00
buildmaster 9fa4d632f5 Bumping versions to 3.1.6-SNAPSHOT after release 2022-11-03 14:26:50 +00:00
buildmaster 62bcecf8ba Going back to snapshots 2022-11-03 14:26:50 +00:00
buildmaster 08179ab430 Update SNAPSHOT to 3.1.5 2022-11-03 14:25:27 +00:00
buildmaster 9e17a7fc8d Going back to snapshots 2022-09-06 19:00:11 +00:00
buildmaster 71ee1e08f7 Update SNAPSHOT to 3.1.4 2022-09-06 18:58:55 +00:00
buildmaster 480c02c009 Bumping versions 2022-09-03 21:35:00 +00:00
buildmaster f59d853039 Bumping versions 2022-09-02 21:35:02 +00:00
buildmaster c344ca06b8 Bumping versions to 3.1.5-SNAPSHOT after release 2022-09-02 20:32:28 +00:00
buildmaster a38b36105b Going back to snapshots 2022-09-02 20:32:28 +00:00
buildmaster b103fbd43f Update SNAPSHOT to 3.1.4 2022-09-02 20:31:14 +00:00
buildmaster 71103bacea Bumping versions 2022-08-31 21:35:06 +00:00
Ryan Baxter 528b03b71f Moving to boot 2.6.11 2022-08-31 10:43:16 -04:00
buildmaster 8cf0076cfc Bumping versions 2022-08-22 21:35:16 +00:00
Tomaz Fernandes 84b9735bac Fix Syntax Highlighting for Documentations (#233)
Resolves GH-232

Syntax highlighting was not being added to code snippets in documentation for projects that inherit from this project.
2022-08-22 12:51:58 +02:00
buildmaster 059b52a282 Bumping versions 2022-08-17 21:35:05 +00:00
Ryan Baxter db0f4d7157 Merge pull request #230 from RobertRad/patch-1
Escape special characters for config Asciidoc
2022-06-29 14:07:15 -04:00
RobertRad 8c8f591c99 Escape special characters for config Asciidoc 2022-06-29 15:43:49 +02:00
buildmaster 08e3b24a27 Bumping versions 2022-06-14 21:35:05 +00:00
spencergibb 317da7a4e4 Updates to next snapshot version 2022-05-27 12:30:19 -04:00
buildmaster eca70fe4cc Update SNAPSHOT to 3.1.3 2022-05-27 12:27:28 -04:00
Marcin Grzejszczak 7e9df7fd7c Allows to disable default deploy by manipulating the phase (#229) 2022-05-26 10:12:51 -04:00
Marcin Grzejszczak 82a1cf794b Update maven.yml 2022-05-19 16:34:51 +02:00
buildmaster 7108146aba Bumping versions to 3.1.3-SNAPSHOT after release 2022-04-27 08:56:14 +00:00
buildmaster 8e81876fd3 Going back to snapshots 2022-04-27 08:56:14 +00:00
buildmaster 95b5890066 Update SNAPSHOT to 3.1.2 2022-04-27 08:54:53 +00:00
Olga Maciaszek-Sharma 63bd653948 Revert "Update SNAPSHOT to 3.1.2"
This reverts commit c3ffb0a5dc.
2022-04-27 10:49:56 +02:00
Olga Maciaszek-Sharma cae59ec9fd Revert "Going back to snapshots"
This reverts commit f4fa5e62cf.
2022-04-27 10:49:52 +02:00
Olga Maciaszek-Sharma 009fee7f44 Revert "Bumping versions to 3.1.3-SNAPSHOT after release"
This reverts commit 119006d160.
2022-04-27 10:49:45 +02:00
Olga Maciaszek-Sharma 63aa041bbb Revert "Bumping versions"
This reverts commit a8d9426206.
2022-04-27 10:49:38 +02:00
Olga Maciaszek-Sharma 83e6e42e54 Revert "Update SNAPSHOT to 3.1.2"
This reverts commit ea265749fa.
2022-04-27 10:49:34 +02:00
Olga Maciaszek-Sharma 13262df844 Revert "Going back to snapshots"
This reverts commit 5dc46d26bb.
2022-04-27 10:49:29 +02:00
Olga Maciaszek-Sharma b83f87423b Revert "Bumping versions to 3.1.3-SNAPSHOT after release"
This reverts commit 769c5e1989.
2022-04-27 10:49:18 +02:00
buildmaster 769c5e1989 Bumping versions to 3.1.3-SNAPSHOT after release 2022-04-27 08:18:32 +00:00
buildmaster 5dc46d26bb Going back to snapshots 2022-04-27 08:18:32 +00:00
buildmaster ea265749fa Update SNAPSHOT to 3.1.2 2022-04-27 08:17:13 +00:00
buildmaster a8d9426206 Bumping versions 2022-04-26 21:35:11 +00:00
buildmaster 119006d160 Bumping versions to 3.1.3-SNAPSHOT after release 2022-04-26 14:55:47 +00:00
buildmaster f4fa5e62cf Going back to snapshots 2022-04-26 14:55:47 +00:00
buildmaster c3ffb0a5dc Update SNAPSHOT to 3.1.2 2022-04-26 14:54:07 +00:00
Ryan Baxter fba352a8af Bumping spring-boot-dependencies 2.6.7 2022-04-21 17:25:26 -04:00
Ryan Baxter ad0826c3e3 Bumping Boot version to 2.6.7 2022-04-21 10:12:01 -04:00
buildmaster 8ff3564115 Bumping versions 2022-03-31 21:06:22 +00:00
buildmaster d04bc15599 Bumping versions to 3.1.2-SNAPSHOT after release 2022-02-14 21:27:38 +00:00
buildmaster f39e225856 Going back to snapshots 2022-02-14 21:27:38 +00:00
buildmaster 4aa9d8cce4 Update SNAPSHOT to 3.1.1 2022-02-14 21:19:54 +00:00
spencergibb 2bb8d61d7d Fixes asciidoc includes for 3.1.x 2022-02-04 14:14:07 -05:00
Artem Bilan 711fbce9ba Remove lf from NewlineAtEndOfFileCheck
Different OSs may check out files with different line separators.
So, to better support other development environments it would be great to just require any end of file, not just Linux-specific.
2022-02-04 11:21:59 -05:00
spencergibb 84ecff1ac8 Updates boot version to 2.6.3 2022-02-04 11:21:22 -05:00
spencergibb 0e31343b92 move comment 2022-02-04 11:20:01 -05:00
14 changed files with 127 additions and 87 deletions
+2 -2
View File
@@ -5,9 +5,9 @@ name: Build
on:
push:
branches: [ main ]
branches: [ main, 3.1.x ]
pull_request:
branches: [ main ]
branches: [ main, 3.1.x ]
jobs:
build:
+9 -8
View File
@@ -47,7 +47,7 @@ $ mvn deploy -P central -DaltReleaseDeploymentRepository=sonatype-nexus-staging:
== Contributing
:spring-cloud-build-branch: master
:spring-cloud-build-branch: 3.1.x
Spring Cloud is released under the non-restrictive Apache 2.0 license,
and follows a very standard Github development process, using Github
@@ -64,7 +64,7 @@ author credit if we do. Active contributors might be asked to join the core tea
given the ability to merge pull requests.
=== Code of Conduct
This project adheres to the Contributor Covenant https://github.com/spring-cloud/spring-cloud-build/blob/master/docs/src/main/asciidoc/code-of-conduct.adoc[code of
This project adheres to the Contributor Covenant https://github.com/spring-cloud/spring-cloud-build/blob/3.1.x/docs/src/main/asciidoc/code-of-conduct.adoc[code of
conduct]. By participating, you are expected to uphold this code. Please report
unacceptable behavior to spring-code-of-conduct@pivotal.io.
@@ -75,7 +75,7 @@ added after the original pull request but before a merge.
* Use the Spring Framework code format conventions. If you use Eclipse
you can import formatter settings using the
`eclipse-code-formatter.xml` file from the
https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-dependencies-parent/eclipse-code-formatter.xml[Spring
https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/3.1.x/spring-cloud-dependencies-parent/eclipse-code-formatter.xml[Spring
Cloud Build] project. If using IntelliJ, you can use the
https://plugins.jetbrains.com/plugin/6546[Eclipse Code Formatter
Plugin] to import the same file.
@@ -171,7 +171,7 @@ If you need to suppress some rules (e.g. line length needs to be longer), then i
It's advisable to copy the `${spring-cloud-build.rootFolder}/.editorconfig` and `${spring-cloud-build.rootFolder}/.springformat` to your project. That way, some default formatting rules will be applied. You can do so by running this script:
```bash
$ curl https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/.editorconfig -o .editorconfig
$ curl https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/3.1.x/.editorconfig -o .editorconfig
$ touch .springformat
```
@@ -180,7 +180,7 @@ $ touch .springformat
==== Intellij IDEA
In order to setup Intellij you should import our coding conventions, inspection profiles and set up the checkstyle plugin.
The following files can be found in the https://github.com/spring-cloud/spring-cloud-build/tree/master/spring-cloud-build-tools[Spring Cloud Build] project.
The following files can be found in the https://github.com/spring-cloud/spring-cloud-build/tree/3.1.x/spring-cloud-build-tools[Spring Cloud Build] project.
.spring-cloud-build-tools/
----
@@ -219,10 +219,10 @@ To have Intellij work with Checkstyle, you have to install the `Checkstyle` plug
image::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/{spring-cloud-build-branch}/docs/src/main/asciidoc/images/intellij-checkstyle.png[Checkstyle]
Go to `File` -> `Settings` -> `Other settings` -> `Checkstyle`. There click on the `+` icon in the `Configuration file` section. There, you'll have to define where the checkstyle rules should be picked from. In the image above, we've picked the rules from the cloned Spring Cloud Build repository. However, you can point to the Spring Cloud Build's GitHub repository (e.g. for the `checkstyle.xml` : `https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-tools/src/main/resources/checkstyle.xml`). We need to provide the following variables:
Go to `File` -> `Settings` -> `Other settings` -> `Checkstyle`. There click on the `+` icon in the `Configuration file` section. There, you'll have to define where the checkstyle rules should be picked from. In the image above, we've picked the rules from the cloned Spring Cloud Build repository. However, you can point to the Spring Cloud Build's GitHub repository (e.g. for the `checkstyle.xml` : `https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/3.1.x/spring-cloud-build-tools/src/main/resources/checkstyle.xml`). We need to provide the following variables:
- `checkstyle.header.file` - please point it to the Spring Cloud Build's, `spring-cloud-build-tools/src/main/resources/checkstyle-header.txt` file either in your cloned repo or via the `https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-tools/src/main/resources/checkstyle-header.txt` URL.
- `checkstyle.suppressions.file` - default suppressions. Please point it to the Spring Cloud Build's, `spring-cloud-build-tools/src/checkstyle/checkstyle-suppressions.xml` file either in your cloned repo or via the `https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-tools/src/checkstyle/checkstyle-suppressions.xml` URL.
- `checkstyle.header.file` - please point it to the Spring Cloud Build's, `spring-cloud-build-tools/src/main/resources/checkstyle-header.txt` file either in your cloned repo or via the `https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/3.1.x/spring-cloud-build-tools/src/main/resources/checkstyle-header.txt` URL.
- `checkstyle.suppressions.file` - default suppressions. Please point it to the Spring Cloud Build's, `spring-cloud-build-tools/src/checkstyle/checkstyle-suppressions.xml` file either in your cloned repo or via the `https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/3.1.x/spring-cloud-build-tools/src/checkstyle/checkstyle-suppressions.xml` URL.
- `checkstyle.additional.suppressions.file` - this variable corresponds to suppressions in your local project. E.g. you're working on `spring-cloud-contract`. Then point to the `project-root/src/checkstyle/checkstyle-suppressions.xml` folder. Example for `spring-cloud-contract` would be: `/home/username/spring-cloud-contract/src/checkstyle/checkstyle-suppressions.xml`.
IMPORTANT: Remember to set the `Scan Scope` to `All sources` since we apply checkstyle rules for production and test sources.
@@ -402,6 +402,7 @@ Spring Cloud Build Docs comes with a set of attributes for asciidoctor that you
<raw-docs-url>${github-raw}@</raw-docs-url>
<project-version>${project.version}@</project-version>
<project-name>${docs.main}@</project-name>
<source-highlighter>highlight.js</source-highlighter>
</attributes>
----
+4 -1
View File
@@ -10,7 +10,7 @@
<parent>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-build</artifactId>
<version>3.1.1-SNAPSHOT</version>
<version>3.1.10-SNAPSHOT</version>
</parent>
<properties>
<docs.main>spring-cloud-build</docs.main>
@@ -20,8 +20,11 @@
<maven-dependency-plugin-for-docs-classes.phase>none</maven-dependency-plugin-for-docs-classes.phase>
<docs.resources.dir>${project.basedir}/src/main/</docs.resources.dir>
<upload-docs-zip.phase>deploy</upload-docs-zip.phase>
<!-- Don't upload docs jar to central / repo.spring.io -->
<maven-deploy-plugin-default.phase>none</maven-deploy-plugin-default.phase>
<!-- We don't want to reference plugin classpath of ourselves -->
<readme.class.path>maven.compile.classpath</readme.class.path>
<spring-cloud-build-docs-classifier></spring-cloud-build-docs-classifier>
</properties>
<dependencies>
<!-- Script -->
+2 -2
View File
@@ -40,7 +40,7 @@ $ mvn deploy -P central -DaltReleaseDeploymentRepository=sonatype-nexus-staging:
== Contributing
include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/docs/src/main/asciidoc/contributing.adoc[]
include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/3.1.x/docs/src/main/asciidoc/contributing.adoc[]
== Flattening the POMs
@@ -128,7 +128,7 @@ Spring Cloud Build Docs comes with a set of attributes for asciidoctor that you
[source,xml]
----
include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/pom.xml[tags=attributes,indent=0]
include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/3.1.x/pom.xml[tags=attributes,indent=0]
----
== Updating the guides
+1 -1
View File
@@ -1,4 +1,4 @@
:jdkversion: 1.8
include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/docs/src/main/asciidoc/building-base.adoc[]
include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/3.1.x/docs/src/main/asciidoc/building-base.adoc[]
+1 -1
View File
@@ -1,3 +1,3 @@
:jdkversion: 1.8
include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/docs/src/main/asciidoc/building-base.adoc[]
include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/3.1.x/docs/src/main/asciidoc/building-base.adoc[]
+8 -8
View File
@@ -1,4 +1,4 @@
:spring-cloud-build-branch: master
:spring-cloud-build-branch: 3.1.x
Spring Cloud is released under the non-restrictive Apache 2.0 license,
and follows a very standard Github development process, using Github
@@ -15,7 +15,7 @@ author credit if we do. Active contributors might be asked to join the core tea
given the ability to merge pull requests.
=== Code of Conduct
This project adheres to the Contributor Covenant https://github.com/spring-cloud/spring-cloud-build/blob/master/docs/src/main/asciidoc/code-of-conduct.adoc[code of
This project adheres to the Contributor Covenant https://github.com/spring-cloud/spring-cloud-build/blob/3.1.x/docs/src/main/asciidoc/code-of-conduct.adoc[code of
conduct]. By participating, you are expected to uphold this code. Please report
unacceptable behavior to spring-code-of-conduct@pivotal.io.
@@ -26,7 +26,7 @@ added after the original pull request but before a merge.
* Use the Spring Framework code format conventions. If you use Eclipse
you can import formatter settings using the
`eclipse-code-formatter.xml` file from the
https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-dependencies-parent/eclipse-code-formatter.xml[Spring
https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/3.1.x/spring-cloud-dependencies-parent/eclipse-code-formatter.xml[Spring
Cloud Build] project. If using IntelliJ, you can use the
https://plugins.jetbrains.com/plugin/6546[Eclipse Code Formatter
Plugin] to import the same file.
@@ -122,7 +122,7 @@ If you need to suppress some rules (e.g. line length needs to be longer), then i
It's advisable to copy the `${spring-cloud-build.rootFolder}/.editorconfig` and `${spring-cloud-build.rootFolder}/.springformat` to your project. That way, some default formatting rules will be applied. You can do so by running this script:
```bash
$ curl https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/.editorconfig -o .editorconfig
$ curl https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/3.1.x/.editorconfig -o .editorconfig
$ touch .springformat
```
@@ -131,7 +131,7 @@ $ touch .springformat
==== Intellij IDEA
In order to setup Intellij you should import our coding conventions, inspection profiles and set up the checkstyle plugin.
The following files can be found in the https://github.com/spring-cloud/spring-cloud-build/tree/master/spring-cloud-build-tools[Spring Cloud Build] project.
The following files can be found in the https://github.com/spring-cloud/spring-cloud-build/tree/3.1.x/spring-cloud-build-tools[Spring Cloud Build] project.
.spring-cloud-build-tools/
----
@@ -170,10 +170,10 @@ To have Intellij work with Checkstyle, you have to install the `Checkstyle` plug
image::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/{spring-cloud-build-branch}/docs/src/main/asciidoc/images/intellij-checkstyle.png[Checkstyle]
Go to `File` -> `Settings` -> `Other settings` -> `Checkstyle`. There click on the `+` icon in the `Configuration file` section. There, you'll have to define where the checkstyle rules should be picked from. In the image above, we've picked the rules from the cloned Spring Cloud Build repository. However, you can point to the Spring Cloud Build's GitHub repository (e.g. for the `checkstyle.xml` : `https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-tools/src/main/resources/checkstyle.xml`). We need to provide the following variables:
Go to `File` -> `Settings` -> `Other settings` -> `Checkstyle`. There click on the `+` icon in the `Configuration file` section. There, you'll have to define where the checkstyle rules should be picked from. In the image above, we've picked the rules from the cloned Spring Cloud Build repository. However, you can point to the Spring Cloud Build's GitHub repository (e.g. for the `checkstyle.xml` : `https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/3.1.x/spring-cloud-build-tools/src/main/resources/checkstyle.xml`). We need to provide the following variables:
- `checkstyle.header.file` - please point it to the Spring Cloud Build's, `spring-cloud-build-tools/src/main/resources/checkstyle-header.txt` file either in your cloned repo or via the `https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-tools/src/main/resources/checkstyle-header.txt` URL.
- `checkstyle.suppressions.file` - default suppressions. Please point it to the Spring Cloud Build's, `spring-cloud-build-tools/src/checkstyle/checkstyle-suppressions.xml` file either in your cloned repo or via the `https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-tools/src/checkstyle/checkstyle-suppressions.xml` URL.
- `checkstyle.header.file` - please point it to the Spring Cloud Build's, `spring-cloud-build-tools/src/main/resources/checkstyle-header.txt` file either in your cloned repo or via the `https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/3.1.x/spring-cloud-build-tools/src/main/resources/checkstyle-header.txt` URL.
- `checkstyle.suppressions.file` - default suppressions. Please point it to the Spring Cloud Build's, `spring-cloud-build-tools/src/checkstyle/checkstyle-suppressions.xml` file either in your cloned repo or via the `https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/3.1.x/spring-cloud-build-tools/src/checkstyle/checkstyle-suppressions.xml` URL.
- `checkstyle.additional.suppressions.file` - this variable corresponds to suppressions in your local project. E.g. you're working on `spring-cloud-contract`. Then point to the `project-root/src/checkstyle/checkstyle-suppressions.xml` folder. Example for `spring-cloud-contract` would be: `/home/username/spring-cloud-contract/src/checkstyle/checkstyle-suppressions.xml`.
IMPORTANT: Remember to set the `Scan Scope` to `All sources` since we apply checkstyle rules for production and test sources.
@@ -144,7 +144,7 @@ public class Main {
}
public String toString() {
return "|" + name + " | " + (StringUtils.hasText(defaultValue) ? ("`" + defaultValue + "`") : "") + " | " + description;
return "|" + name + " | " + (StringUtils.hasText(defaultValue) ? ("`+++" + defaultValue + "+++`") : "") + " | " + description;
}
}
+2 -2
View File
@@ -40,7 +40,7 @@ $ mvn deploy -P central -DaltReleaseDeploymentRepository=sonatype-nexus-staging:
== Contributing
include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/docs/src/main/asciidoc/contributing.adoc[]
include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/3.1.x/docs/src/main/asciidoc/contributing.adoc[]
== Flattening the POMs
@@ -128,7 +128,7 @@ Spring Cloud Build Docs comes with a set of attributes for asciidoctor that you
[source,xml]
----
include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/pom.xml[tags=attributes,indent=0]
include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/3.1.x/pom.xml[tags=attributes,indent=0]
----
== Updating the guides
+77 -51
View File
@@ -5,7 +5,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-build</artifactId>
<version>3.1.1-SNAPSHOT</version>
<version>3.1.10-SNAPSHOT</version>
<packaging>pom</packaging>
<name>Spring Cloud Parent</name>
<description>Spring Cloud parent pom, managing plugins and dependencies for Spring
@@ -20,24 +20,20 @@
<url>https://spring.io/spring-cloud</url>
<properties>
<java.version>1.8</java.version>
<resource.delimiter>@
</resource.delimiter> <!-- delimiter that doesn't clash with Spring ${} placeholders -->
<!-- delimiter that doesn't clash with Spring ${} placeholders -->
<resource.delimiter>@</resource.delimiter>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<maven.compiler.source>${java.version}</maven.compiler.source>
<maven.compiler.target>${java.version}</maven.compiler.target>
<main.basedir>${basedir}</main.basedir>
<docs.main>${project.artifactId}</docs.main>
<spring-boot.version>2.6.1</spring-boot.version>
<spring-cloud-build.version>3.1.1-SNAPSHOT</spring-cloud-build.version>
<spring-boot.version>2.6.15</spring-boot.version>
<spring-cloud-build.version>3.1.10-SNAPSHOT</spring-cloud-build.version>
<docs.resources.dir>${project.build.directory}/build-docs</docs.resources.dir>
<docs.classes.dir>${project.build.directory}/build-docs-classes</docs.classes.dir>
<refdocs.build.directory>${project.build.directory}/refdocs/</refdocs.build.directory>
<spring-doc-resources.version>0.2.2.RELEASE</spring-doc-resources.version>
<spring-asciidoctor-extensions-boot.version>0.6.0
</spring-asciidoctor-extensions-boot.version>
<spring-asciidoctor-extensions-block.version>0.6.0
</spring-asciidoctor-extensions-block.version>
<spring-asciidoctor-backends.version>0.0.7</spring-asciidoctor-backends.version>
<asciidoctorj-pdf.version>1.6.0</asciidoctorj-pdf.version>
<asciidoctorj-diagram.version>2.1.2</asciidoctorj-diagram.version>
<guides-project.version>${project.version}</guides-project.version>
@@ -73,7 +69,7 @@
<git-commit-id-plugin.version>4.0.5</git-commit-id-plugin.version>
<maven-shade-plugin.version>3.2.4</maven-shade-plugin.version>
<maven-enforcer-plugin.version>3.0.0-M3</maven-enforcer-plugin.version><!-- @releaser:version-check-off -->
<maven-gpg-plugin.version>3.0.1</maven-gpg-plugin.version>
<maven-gpg-plugin.version>3.2.7</maven-gpg-plugin.version>
<maven-dependency-plugin.version>3.2.0</maven-dependency-plugin.version>
<asciidoctor-maven-plugin.version>2.1.0</asciidoctor-maven-plugin.version>
<build-helper-maven-plugin.version>3.2.0</build-helper-maven-plugin.version>
@@ -89,8 +85,9 @@
</maven-checkstyle-plugin.failOnViolation>
<maven-checkstyle-plugin.includeTestSourceDirectory>true
</maven-checkstyle-plugin.includeTestSourceDirectory>
<spring-cloud-build-checkstyle.branch>master
<spring-cloud-build-checkstyle.branch>main
</spring-cloud-build-checkstyle.branch>
<spring-cloud-build-docs-classifier>jar-with-dependencies</spring-cloud-build-docs-classifier>
<checkstyle.suppressions.file>
https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/${spring-cloud-build-checkstyle.branch}/spring-cloud-build-tools/src/checkstyle/checkstyle-suppressions.xml
</checkstyle.suppressions.file>
@@ -114,6 +111,7 @@
<generated-docs-pdf-output.dir>${project.build.directory}/generated-docs/reference/pdf</generated-docs-pdf-output.dir>
<javadoc.failOnError>false</javadoc.failOnError>
<javadoc.failOnWarnings>false</javadoc.failOnWarnings>
<maven-deploy-plugin-default.phase>deploy</maven-deploy-plugin-default.phase>
<maven-deploy-plugin.version>2.8.2</maven-deploy-plugin.version>
<maven-deploy-plugin.deployZipRepositoryId>repo.spring.io</maven-deploy-plugin.deployZipRepositoryId>
<maven-deploy-plugin.deployZipUrl>https://repo.spring.io/libs-snapshot-local</maven-deploy-plugin.deployZipUrl>
@@ -139,6 +137,11 @@
<duplicate-finder-maven-plugin.bootClasspathProperty>sun.boot.class.path</duplicate-finder-maven-plugin.bootClasspathProperty>
<duplicate-finder-maven-plugin.useDefaultResourceIgnoreList>true</duplicate-finder-maven-plugin.useDefaultResourceIgnoreList>
<duplicate-finder-maven-plugin.includePomProjects>false</duplicate-finder-maven-plugin.includePomProjects>
<maven-gpg-plugin.phase>verify</maven-gpg-plugin.phase>
<unpack-docs-resources.phase>generate-resources</unpack-docs-resources.phase>
<generate-docs.phase>prepare-package</generate-docs.phase>
<copy-missing-html-files.phase>package</copy-missing-html-files.phase>
<package-and-attach-docs-zip.phase>package</package-and-attach-docs-zip.phase>
</properties>
<dependencyManagement>
<dependencies>
@@ -839,12 +842,18 @@
<executions>
<execution>
<id>sign-artifacts</id>
<phase>verify</phase>
<phase>${maven-gpg-plugin.phase}</phase>
<goals>
<goal>sign</goal>
</goals>
</execution>
</executions>
<configuration>
<gpgArguments>
<arg>--pinentry-mode</arg>
<arg>loopback</arg>
</gpgArguments>
</configuration>
</plugin>
</plugins>
</build>
@@ -1052,25 +1061,6 @@
</artifactItems>
</configuration>
</execution>
<execution>
<id>unpack-docs-resources</id>
<phase>generate-resources</phase>
<goals>
<goal>unpack</goal>
</goals>
<configuration>
<artifactItems>
<artifactItem>
<groupId>io.spring.docresources</groupId>
<artifactId>spring-doc-resources</artifactId>
<version>${spring-doc-resources.version}</version>
<type>zip</type>
<overWrite>true</overWrite>
<outputDirectory>${refdocs.build.directory}</outputDirectory>
</artifactItem>
</artifactItems>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
@@ -1118,6 +1108,7 @@
</artifactId>
<version>${spring-cloud-build.version}
</version>
<classifier>${spring-cloud-build-docs-classifier}</classifier>
<type>jar</type>
</dependency>
</dependencies>
@@ -1137,16 +1128,6 @@
<artifactId>asciidoctor-maven-plugin</artifactId>
<version>${asciidoctor-maven-plugin.version}</version>
<dependencies>
<dependency>
<groupId>io.spring.asciidoctor</groupId>
<artifactId>spring-asciidoctor-extensions-spring-boot</artifactId>
<version>${spring-asciidoctor-extensions-boot.version}</version>
</dependency>
<dependency>
<groupId>io.spring.asciidoctor</groupId>
<artifactId>spring-asciidoctor-extensions-block-switch</artifactId>
<version>${spring-asciidoctor-extensions-block.version}</version>
</dependency>
<dependency>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctorj-pdf</artifactId>
@@ -1157,6 +1138,11 @@
<artifactId>asciidoctorj-diagram</artifactId>
<version>${asciidoctorj-diagram.version}</version>
</dependency>
<dependency>
<groupId>io.spring.asciidoctor.backends</groupId>
<artifactId>spring-asciidoctor-backends</artifactId>
<version>${spring-asciidoctor-backends.version}</version>
</dependency>
</dependencies>
<configuration>
<sourceDirectory>${refdocs.build.directory}</sourceDirectory>
@@ -1207,6 +1193,7 @@
<raw-docs-url>${github-raw}@</raw-docs-url>
<project-version>${project.version}@</project-version>
<project-name>${docs.main}@</project-name>
<source-highlighter>highlight.js</source-highlighter>
</attributes>
<!-- end::attributes[] -->
<requires>
@@ -1216,12 +1203,12 @@
<executions>
<execution>
<id>generate-html-documentation</id>
<phase>prepare-package</phase>
<phase>${generate-docs.phase}</phase>
<goals>
<goal>process-asciidoc</goal>
</goals>
<configuration>
<backend>html5</backend>
<backend>spring-html</backend>
<sourceDocumentExtensions>
<sourceDocumentExtension>.adoc</sourceDocumentExtension>
<sourceDocumentExtension>.htmladoc</sourceDocumentExtension>
@@ -1239,7 +1226,7 @@
<highlightjs-theme>github</highlightjs-theme>
<imagesdir>./images</imagesdir>
<attribute-missing>warn</attribute-missing>
<sourceHighlighter>highlight.js</sourceHighlighter>
<source-highlighter>highlight.js</source-highlighter>
</attributes>
<logHandler>
<outputToConsole>true</outputToConsole>
@@ -1251,21 +1238,21 @@
</execution>
<execution>
<id>generate-htmlsingle-documentation</id>
<phase>prepare-package</phase>
<phase>${generate-docs.phase}</phase>
<goals>
<goal>process-asciidoc</goal>
</goals>
<configuration>
<backend>html5</backend>
<backend>spring-html</backend>
<sourceDocumentExtensions>
<sourceDocumentExtension>.htmlsingleadoc</sourceDocumentExtension>
</sourceDocumentExtensions>
<outputDirectory>
${generated-docs-singlepage-output.dir}
</outputDirectory>
<sourceHighlighter>highlight.js</sourceHighlighter>
<doctype>book</doctype>
<attributes>
<source-highlighter>highlight.js</source-highlighter>
<docinfo>shared</docinfo>
<stylesdir>css/</stylesdir>
<stylesheet>spring.css</stylesheet>
@@ -1279,7 +1266,7 @@
</execution>
<execution>
<id>generate-pdf-documentation</id>
<phase>prepare-package</phase>
<phase>${generate-docs.phase}</phase>
<goals>
<goal>process-asciidoc</goal>
</goals>
@@ -1363,7 +1350,7 @@
</execution>
<execution>
<id>assert-no-unresolved-links</id>
<phase>prepare-package</phase>
<phase>${generate-docs.phase}</phase>
<goals>
<goal>run</goal>
</goals>
@@ -1383,9 +1370,24 @@
</target>
</configuration>
</execution>
<execution>
<id>copy-missing-html-files</id>
<phase>${copy-missing-html-files.phase}</phase>
<goals>
<goal>run</goal>
</goals>
<configuration>
<failOnError>false</failOnError>
<target>
<copy tofile="${project.build.directory}/generated-docs/reference/htmlsingle/index.html">
<fileset dir="${project.build.directory}/generated-docs/reference/htmlsingle" includes="${docs.main}.html" />
</copy>
</target>
</configuration>
</execution>
<execution>
<id>package-and-attach-docs-zip</id>
<phase>package</phase>
<phase>${package-and-attach-docs-zip.phase}</phase>
<goals>
<goal>run</goal>
</goals>
@@ -1466,6 +1468,13 @@
<artifactId>maven-deploy-plugin</artifactId>
<version>${maven-deploy-plugin.version}</version>
<executions>
<execution>
<id>default-deploy</id>
<phase>${maven-deploy-plugin-default.phase}</phase>
<goals>
<goal>deploy</goal>
</goals>
</execution>
<execution>
<id>upload-docs-zip</id>
<phase>${upload-docs-zip.phase}</phase>
@@ -1632,5 +1641,22 @@
</plugins>
</build>
</profile>
<profile>
<id>CI</id>
<activation>
<property>
<name>env.GITHUB_API_URL</name>
</property>
</activation>
<properties>
<!-- This jar requires authentication, we don't need anything css related in a PR -->
<unpack-docs-resources.phase>none</unpack-docs-resources.phase>
<!-- Because of this we will not be catching broken docs in the PRs -->
<generate-docs.phase>none</generate-docs.phase>
<copy-missing-html-files.phase>none</copy-missing-html-files.phase>
<package-and-attach-docs-zip.phase>none</package-and-attach-docs-zip.phase>
<upload-docs-zip.phase>none</upload-docs-zip.phase>
</properties>
</profile>
</profiles>
</project>
+10 -4
View File
@@ -5,7 +5,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-build-dependencies</artifactId>
<version>3.1.1-SNAPSHOT</version>
<version>3.1.10-SNAPSHOT</version>
<name>spring-cloud-build-dependencies</name>
<packaging>pom</packaging>
<description>Spring Cloud Build Dependencies: an internal BOM for use with Spring
@@ -14,13 +14,13 @@
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-dependencies</artifactId>
<version>2.6.1</version>
<version>2.6.15</version>
<relativePath/>
</parent>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<spring-boot.version>2.6.1</spring-boot.version>
<maven-gpg-plugin.version>3.0.1</maven-gpg-plugin.version>
<spring-boot.version>2.6.15</spring-boot.version>
<maven-gpg-plugin.version>3.2.7</maven-gpg-plugin.version>
</properties>
<build>
<plugins>
@@ -118,6 +118,12 @@
</goals>
</execution>
</executions>
<configuration>
<gpgArguments>
<arg>--pinentry-mode</arg>
<arg>loopback</arg>
</gpgArguments>
</configuration>
</plugin>
</plugins>
</build>
+1 -1
View File
@@ -10,7 +10,7 @@
<parent>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-build</artifactId>
<version>3.1.1-SNAPSHOT</version>
<version>3.1.10-SNAPSHOT</version>
</parent>
<dependencies>
<dependency>
@@ -20,9 +20,7 @@
<property name="headerFile" value="${checkstyle.header.file}"/>
<property name="fileExtensions" value="java,groovy"/>
</module>
<module name="com.puppycrawl.tools.checkstyle.checks.NewlineAtEndOfFileCheck">
<property name="lineSeparator" value="lf"/>
</module>
<module name="com.puppycrawl.tools.checkstyle.checks.NewlineAtEndOfFileCheck"/>
<!-- TreeWalker Checks -->
<module name="com.puppycrawl.tools.checkstyle.TreeWalker">
+8 -2
View File
@@ -4,7 +4,7 @@
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.springframework.cloud</groupId>
<version>3.1.1-SNAPSHOT</version>
<version>3.1.10-SNAPSHOT</version>
<artifactId>spring-cloud-dependencies-parent</artifactId>
<packaging>pom</packaging>
<name>spring-cloud-dependencies-parent</name>
@@ -154,7 +154,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-gpg-plugin</artifactId>
<version>1.6</version>
<version>3.2.7</version>
<executions>
<execution>
<id>sign-artifacts</id>
@@ -164,6 +164,12 @@
</goals>
</execution>
</executions>
<configuration>
<gpgArguments>
<arg>--pinentry-mode</arg>
<arg>loopback</arg>
</gpgArguments>
</configuration>
</plugin>
</plugins>
</build>