Compare commits

...
153 Commits
Author SHA1 Message Date
buildmaster f20e58b49c Update SNAPSHOT to 4.0.5 2023-07-27 19:22:04 +00:00
Olga MaciaszekSharma 1b60c5b801 Upgrade to Boot 3.0.9. 2023-07-26 16:46:13 +02:00
buildmaster 53f01d9804 Bumping versions 2023-07-07 04:11:30 +00:00
buildmaster 413ada770c Bumping versions to 4.0.5-SNAPSHOT after release 2023-07-06 06:36:03 +00:00
buildmaster 00d08e83b0 Going back to snapshots 2023-07-06 06:36:03 +00:00
buildmaster c3995a08fa Update SNAPSHOT to 4.0.4 2023-07-06 06:34:30 +00:00
Marcin Grzejszczak 21a18395fa Merge branch '3.1.x' into 4.0.x 2023-06-27 16:04:31 +02: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 a14578930a Merge branch '3.1.x' into 4.0.x 2023-06-26 14:40:56 +02:00
Marcin Grzejszczak 6f7f008710 Uses jar-with-deps for sc-build-docs; fixes gh-238 2023-06-26 14:40:37 +02:00
Spencer Gibb 2701008de8 Updates spring-asciidoctor-backends version to 0.0.5 2023-06-20 12:21:05 -04:00
buildmaster 3243b7a322 Bumping versions 2023-05-25 23:06:26 +00:00
buildmaster cb733fd590 Bumping versions 2023-05-25 14:57:21 +00:00
buildmaster a6af2759db Bumping versions to 4.0.4-SNAPSHOT after release 2023-05-24 17:16:10 +00:00
buildmaster 5d6caf1235 Going back to snapshots 2023-05-24 17:16:10 +00:00
buildmaster 8420504e81 Update SNAPSHOT to 4.0.3 2023-05-24 17:14:35 +00:00
Marcin Grzejszczak 737a871aae Merge branch '3.1.x' 2023-05-04 17:12:43 +02:00
Marcin Grzejszczak 240995fa09 Created a separate task; related to gh-221 2023-05-04 17:12:35 +02:00
Marcin Grzejszczak 6aa7ce8922 Merge branch '3.1.x' 2023-05-04 17:07:47 +02:00
Marcin Grzejszczak 661a4ccb61 Don't fail on error; related to gh-221 2023-05-04 17:07:32 +02:00
Marcin Grzejszczak 753c1e78db Merge branch '3.1.x' 2023-05-04 17:03:08 +02:00
Marcin Grzejszczak 983d743cd6 Adds a conditional on folder; related to gh-221 2023-05-04 17:03:02 +02:00
Marcin Grzejszczak d94e0350a3 Merge branch '3.1.x' 2023-05-04 16:46:07 +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 0c8a004022 Bumping versions 2023-03-29 14:58:01 +00:00
buildmaster 2ddad64197 Bumping versions 2023-03-28 14:57:34 +00:00
buildmaster b39ddf77cd Bumping versions to 4.0.3-SNAPSHOT after release 2023-03-28 13:31:40 +00:00
buildmaster aa945db6ba Going back to snapshots 2023-03-28 13:31:40 +00:00
buildmaster df48f5dd5f Update SNAPSHOT to 4.0.2 2023-03-28 13:30:08 +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 9aad646584 Merge branch '3.1.x' 2023-02-07 16:20:31 +01: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 fe397f39b3 Bumping versions 2023-01-26 14:57:34 +00:00
buildmaster 7af9936776 Bumping versions 2023-01-25 14:57:26 +00:00
buildmaster 802459a94d Bumping versions to 4.0.2-SNAPSHOT after release 2023-01-25 13:55:43 +00:00
buildmaster 2da5576afc Going back to snapshots 2023-01-25 13:55:43 +00:00
buildmaster fec1fd6592 Update SNAPSHOT to 4.0.1 2023-01-25 13:54:12 +00:00
buildmaster fee3542395 Bumping versions 2022-12-20 14:57:23 +00:00
buildmaster 389e806ab4 Bumping versions 2022-12-17 14:57:20 +00:00
buildmaster 7db0179851 Bumping versions 2022-12-16 14:57:20 +00:00
buildmaster 60fd117a72 Bumping versions to 4.0.1-SNAPSHOT after release 2022-12-15 19:46:06 +00:00
buildmaster 9ba1bd0004 Going back to snapshots 2022-12-15 19:46:05 +00:00
buildmaster d0a0fcbe55 Update SNAPSHOT to 4.0.0 2022-12-15 19:44:41 +00:00
Marcin Grzejszczak 8824d89285 Update gpg plugin to 3.0.1
There's no 3.2.0 version available
2022-12-15 12:12:03 +01:00
spencergibb 410e50327a Revert "Removes libs-*-local repositories"
This reverts commit c7c3d42f89.
2022-12-13 16:34:01 -05:00
spencergibb c7c3d42f89 Removes libs-*-local repositories 2022-12-13 15:22:06 -05:00
buildmaster 674493178a Going back to snapshots 2022-12-01 16:58:14 +00:00
buildmaster 3fd1f8194d Update SNAPSHOT to 4.0.0-RC3 2022-12-01 16:56:57 +00:00
buildmaster ab53ece701 Bumping versions 2022-11-28 17:11:57 +00:00
buildmaster ed293ba424 Bumping versions 2022-11-21 14:57:26 +00:00
buildmaster f6fee4a4d1 Going back to snapshots 2022-11-17 16:33:49 +00:00
buildmaster 0a5fc5c356 Update SNAPSHOT to 4.0.0-RC2 2022-11-17 16:32:31 +00:00
buildmaster ca4c8114e0 Bumping versions 2022-11-15 15:09:55 +00: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 7fe9f123b9 Bumping versions 2022-10-31 16:37:34 +00:00
buildmaster bfbe4ab22d Going back to snapshots 2022-10-27 21:08:44 +00:00
buildmaster d944721b95 Update SNAPSHOT to 4.0.0-RC1 2022-10-27 21:07:28 +00:00
buildmaster 058d3d8469 Bumping versions 2022-10-25 20:30:42 +00:00
Ryan Baxter 4d95b4de06 Merge pull request #237 from wind57/bump-formatter-version
bump formatter version
2022-10-12 08:33:28 -04:00
wind57 1997e21fe6 fix 2022-10-12 13:54:26 +03:00
buildmaster cdc7b77b7c Bumping versions 2022-10-10 16:21:28 +00:00
buildmaster f685b9eca4 Going back to snapshots 2022-10-06 00:16:35 +00:00
buildmaster d894bb5d70 Update SNAPSHOT to 4.0.0-M5 2022-10-06 00:15:17 +00:00
buildmaster 717f97b455 Bumping versions 2022-09-29 14:40:56 +00:00
Ryan Baxter f9f3341bb0 Merge pull request #235 from wind57/bump-formatter
Update Java format plugin version
2022-09-11 08:23:08 -04:00
wind57 4c6634771f fix 2022-09-10 13:17:03 +03: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
Jay BryantandJay Bryant a2a40673d8 Switch to using spring-asciidoctor-backends (#234)
to get the new look and feel and features for the reference docs.

Co-authored-by: Jay Bryant <jbryant@vmware.com>
2022-08-24 13:52:14 -04:00
buildmaster 8cf0076cfc Bumping versions 2022-08-22 21:35:16 +00:00
buildmaster a3f7ab02b9 Bumping versions 2022-08-22 14:57:46 +00:00
Marcin Grzejszczak 6dcc3a8bd8 Merge branch '3.1.x' 2022-08-22 13:33:12 +02: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
Tomaz Fernandes f1015193db 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:20 +02:00
buildmaster 059b52a282 Bumping versions 2022-08-17 21:35:05 +00:00
Olga Maciaszek-Sharma 68de0d967f Increase class access for tests. 2022-08-11 16:18:09 +02:00
buildmaster 7401e65427 Bumping versions 2022-08-02 17:41:31 +00:00
buildmaster 82e6c482e0 Going back to snapshots 2022-07-29 18:36:08 +00:00
buildmaster 289e87195c Update SNAPSHOT to 4.0.0-M4 2022-07-29 18:34:55 +00:00
buildmaster f024dadefa Bumping versions 2022-07-21 14:52:39 +00:00
RobertRad 383ae64dbb Escape special characters for config Asciidoc 2022-06-29 14:07:42 -04: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 20df35799d Going back to snapshots 2022-06-15 08:45:27 +00:00
buildmaster 0e9ac25dd5 Update SNAPSHOT to 4.0.0-M3 2022-06-15 08:43:29 +00: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
Marcin Grzejszczak 49dd7deec2 Revert "Bumping versions"
This reverts commit 1c104f1837.
2022-04-27 16:44:17 +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 1c104f1837 Bumping versions 2022-04-26 14:57:29 +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
Marcin Grzejszczak 55b2c63b0a Revert "Bumping versions"
This reverts commit 7c613551d0.
2022-04-26 09:38:59 +02:00
buildmaster 7c613551d0 Bumping versions 2022-04-25 14:57:25 +00:00
Marcin Grzejszczak d48985e4fd Going back to Spring Boot 3.0.0-SNAPSHOT 2022-04-25 16:22:06 +02: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 1a1e2f7a45 Going back to snapshots 2022-03-31 16:24:12 +00:00
buildmaster 0fbe1ca90a Update SNAPSHOT to 4.0.0-M2 2022-03-31 16:23:01 +00:00
buildmaster 2830e11a3b Bumping versions 2022-03-25 14:55:17 +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
spencergibb c1bb7946cc Fixes asciidoc includes for main 2022-02-04 14:16:23 -05:00
spencergibb 1d354900b7 Merge branch '3.1.x' 2022-02-04 14:15:25 -05:00
spencergibb f005cfaa2b Merge branch '3.1.x' 2022-02-04 11:24:07 -05:00
spencergibb 592d80f379 Adds building-jdk8.adoc for backwards compatibility 2022-02-03 13:08:27 -05:00
spencergibb 40ae242fe8 Updates docs to reflect java 17.
Removed building-base.adoc and building-jdk8.adoc
2022-02-03 12:46:04 -05:00
buildmaster b94c72ea30 Bumping versions 2022-01-26 08:13:45 +00:00
buildmaster d9bdd101ac Going back to snapshots 2022-01-25 17:44:45 +00:00
buildmaster 41669f2cc5 Update SNAPSHOT to 4.0.0-M1 2022-01-25 17:43:30 +00:00
Glenn Renfro 0afa19a2e1 Updated version for the various components.
Was unable to update asciidoctor-maven-plugin from 2.1.0 -> 2.2.1 because of build failure.
Need to investigate for M2
2022-01-24 11:48:17 -05:00
Marcin Grzejszczak d135092150 Update maven.yml 2022-01-17 10:38:32 +01:00
Ryan Baxter 4b3c5c511c Bump jacoco plugin to 0.8.7 2022-01-12 11:12:14 -05:00
spencergibb e0ad557de9 Updates sdkman to java 17 temurin 2022-01-03 14:25:20 -05:00
spencergibb eb0d694c4e Merge branch '3.1.x' 2022-01-03 14:17:19 -05:00
spencergibb c55d97d47c Updates to version 4.0.0-SNAPSHOT and boot 3.0.0 2022-01-03 14:14:44 -05:00
15 changed files with 184 additions and 168 deletions
+4 -8
View File
@@ -5,25 +5,21 @@ name: Build
on:
push:
branches: [ main ]
branches: [ main, 3.1.x ]
pull_request:
branches: [ main ]
branches: [ main, 3.1.x ]
jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
java: ["8", "11", "16"]
steps:
- uses: actions/checkout@v2
- name: Set up JDK 1.8
- name: Set up JDK
uses: actions/setup-java@v1
with:
java-version: 1.8
java-version: 17
- name: Cache local Maven repository
uses: actions/cache@v2
with:
+1 -1
View File
@@ -1,2 +1,2 @@
distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.6.3/apache-maven-3.6.3-bin.zip
distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.8.4/apache-maven-3.8.4-bin.zip
wrapperUrl=https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar
+1 -1
View File
@@ -1,3 +1,3 @@
# Enable auto-env through the sdkman_auto_env config
# Add key=value pairs of SDKs to use below
java=8.0.292.hs-adpt
java=17.0.1-tem
+1
View File
@@ -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</version>
<version>4.0.5</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/3.1.x/docs/src/main/asciidoc/contributing.adoc[]
include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/main/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/3.1.x/pom.xml[tags=attributes,indent=0]
include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/main/pom.xml[tags=attributes,indent=0]
----
== Updating the guides
-77
View File
@@ -1,77 +0,0 @@
=== Basic Compile and Test
To build the source you will need to install JDK {jdkversion}.
Spring Cloud uses Maven for most build-related activities, and you
should be able to get off the ground quite quickly by cloning the
project you are interested in and typing
----
$ ./mvnw install
----
NOTE: You can also install Maven (>=3.3.3) yourself and run the `mvn` command
in place of `./mvnw` in the examples below. If you do that you also
might need to add `-P spring` if your local Maven settings do not
contain repository declarations for spring pre-release artifacts.
NOTE: Be aware that you might need to increase the amount of memory
available to Maven by setting a `MAVEN_OPTS` environment variable with
a value like `-Xmx512m -XX:MaxPermSize=128m`. We try to cover this in
the `.mvn` configuration, so if you find you have to do it to make a
build succeed, please raise a ticket to get the settings added to
source control.
The projects that require middleware (i.e. Redis) for testing generally
require that a local instance of [Docker](https://www.docker.com/get-started) is installed and running.
=== Documentation
The spring-cloud-build module has a "docs" profile, and if you switch
that on it will try to build asciidoc sources from
`src/main/asciidoc`. As part of that process it will look for a
`README.adoc` and process it by loading all the includes, but not
parsing or rendering it, just copying it to `${main.basedir}`
(defaults to `${basedir}`, i.e. the root of the project). If there are
any changes in the README it will then show up after a Maven build as
a modified file in the correct place. Just commit it and push the change.
=== Working with the code
If you don't have an IDE preference we would recommend that you use
https://www.springsource.com/developer/sts[Spring Tools Suite] or
https://eclipse.org[Eclipse] when working with the code. We use the
https://eclipse.org/m2e/[m2eclipse] eclipse plugin for maven support. Other IDEs and tools
should also work without issue as long as they use Maven 3.3.3 or better.
==== Activate the Spring Maven profile
Spring Cloud projects require the 'spring' Maven profile to be activated to resolve
the spring milestone and snapshot repositories. Use your preferred IDE to set this
profile to be active, or you may experience build errors.
==== Importing into eclipse with m2eclipse
We recommend the https://eclipse.org/m2e/[m2eclipse] eclipse plugin when working with
eclipse. If you don't already have m2eclipse installed it is available from the "eclipse
marketplace".
NOTE: Older versions of m2e do not support Maven 3.3, so once the
projects are imported into Eclipse you will also need to tell
m2eclipse to use the right profile for the projects. If you
see many different errors related to the POMs in the projects, check
that you have an up to date installation. If you can't upgrade m2e,
add the "spring" profile to your `settings.xml`. Alternatively you can
copy the repository settings from the "spring" profile of the parent
pom into your `settings.xml`.
==== Importing into eclipse without m2eclipse
If you prefer not to use m2eclipse you can generate eclipse project metadata using the
following command:
[indent=0]
----
$ ./mvnw eclipse:eclipse
----
The generated eclipse projects can be imported by selecting `import existing projects`
from the `file` menu.
+1 -2
View File
@@ -1,4 +1,3 @@
:jdkversion: 1.8
include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/3.1.x/docs/src/main/asciidoc/building-base.adoc[]
include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/main/docs/src/main/asciidoc/building.adoc[]
+78 -2
View File
@@ -1,3 +1,79 @@
:jdkversion: 1.8
:jdkversion: 17
=== Basic Compile and Test
To build the source you will need to install JDK {jdkversion}.
Spring Cloud uses Maven for most build-related activities, and you
should be able to get off the ground quite quickly by cloning the
project you are interested in and typing
----
$ ./mvnw install
----
NOTE: You can also install Maven (>=3.3.3) yourself and run the `mvn` command
in place of `./mvnw` in the examples below. If you do that you also
might need to add `-P spring` if your local Maven settings do not
contain repository declarations for spring pre-release artifacts.
NOTE: Be aware that you might need to increase the amount of memory
available to Maven by setting a `MAVEN_OPTS` environment variable with
a value like `-Xmx512m -XX:MaxPermSize=128m`. We try to cover this in
the `.mvn` configuration, so if you find you have to do it to make a
build succeed, please raise a ticket to get the settings added to
source control.
The projects that require middleware (i.e. Redis) for testing generally
require that a local instance of [Docker](https://www.docker.com/get-started) is installed and running.
=== Documentation
The spring-cloud-build module has a "docs" profile, and if you switch
that on it will try to build asciidoc sources from
`src/main/asciidoc`. As part of that process it will look for a
`README.adoc` and process it by loading all the includes, but not
parsing or rendering it, just copying it to `${main.basedir}`
(defaults to `${basedir}`, i.e. the root of the project). If there are
any changes in the README it will then show up after a Maven build as
a modified file in the correct place. Just commit it and push the change.
=== Working with the code
If you don't have an IDE preference we would recommend that you use
https://www.springsource.com/developer/sts[Spring Tools Suite] or
https://eclipse.org[Eclipse] when working with the code. We use the
https://eclipse.org/m2e/[m2eclipse] eclipse plugin for maven support. Other IDEs and tools
should also work without issue as long as they use Maven 3.3.3 or better.
==== Activate the Spring Maven profile
Spring Cloud projects require the 'spring' Maven profile to be activated to resolve
the spring milestone and snapshot repositories. Use your preferred IDE to set this
profile to be active, or you may experience build errors.
==== Importing into eclipse with m2eclipse
We recommend the https://eclipse.org/m2e/[m2eclipse] eclipse plugin when working with
eclipse. If you don't already have m2eclipse installed it is available from the "eclipse
marketplace".
NOTE: Older versions of m2e do not support Maven 3.3, so once the
projects are imported into Eclipse you will also need to tell
m2eclipse to use the right profile for the projects. If you
see many different errors related to the POMs in the projects, check
that you have an up to date installation. If you can't upgrade m2e,
add the "spring" profile to your `settings.xml`. Alternatively you can
copy the repository settings from the "spring" profile of the parent
pom into your `settings.xml`.
==== Importing into eclipse without m2eclipse
If you prefer not to use m2eclipse you can generate eclipse project metadata using the
following command:
[indent=0]
----
$ ./mvnw eclipse:eclipse
----
The generated eclipse projects can be imported by selecting `import existing projects`
from the `file` menu.
include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/3.1.x/docs/src/main/asciidoc/building-base.adoc[]
@@ -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/3.1.x/docs/src/main/asciidoc/contributing.adoc[]
include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/main/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/3.1.x/pom.xml[tags=attributes,indent=0]
include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/main/pom.xml[tags=attributes,indent=0]
----
== Updating the guides
+84 -66
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</version>
<version>4.0.5</version>
<packaging>pom</packaging>
<name>Spring Cloud Parent</name>
<description>Spring Cloud parent pom, managing plugins and dependencies for Spring
@@ -19,7 +19,7 @@
</modules>
<url>https://spring.io/spring-cloud</url>
<properties>
<java.version>1.8</java.version>
<java.version>17</java.version>
<!-- delimiter that doesn't clash with Spring ${} placeholders -->
<resource.delimiter>@</resource.delimiter>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
@@ -28,22 +28,18 @@
<maven.compiler.target>${java.version}</maven.compiler.target>
<main.basedir>${basedir}</main.basedir>
<docs.main>${project.artifactId}</docs.main>
<spring-boot.version>2.6.3</spring-boot.version>
<spring-cloud-build.version>3.1.1</spring-cloud-build.version>
<spring-boot.version>3.0.9</spring-boot.version>
<spring-cloud-build.version>4.0.5</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>
<asciidoctorj-pdf.version>1.6.0</asciidoctorj-pdf.version>
<spring-asciidoctor-backends.version>0.0.5</spring-asciidoctor-backends.version>
<asciidoctorj-pdf.version>1.6.2</asciidoctorj-pdf.version>
<asciidoctorj-diagram.version>2.1.2</asciidoctorj-diagram.version>
<guides-project.version>${project.version}</guides-project.version>
<guides-update.phase>deploy</guides-update.phase>
<revision>${project.version}</revision>
<asciidoctorj.version>2.5.1</asciidoctorj.version>
<asciidoctorj.version>2.5.3</asciidoctorj.version>
<jruby-complete.version>9.2.19.0</jruby-complete.version>
<!-- Sonar -->
@@ -54,35 +50,35 @@
<sonar.language>java</sonar.language>
<!-- Plugins -->
<maven-compiler-plugin.version>3.8.1</maven-compiler-plugin.version>
<maven-compiler-plugin.version>3.9.0</maven-compiler-plugin.version>
<maven-eclipse-plugin.version>2.10</maven-eclipse-plugin.version>
<!-- for backwards compatibility, use maven-checkstyle-plugin.version -->
<checkstyle.version>${maven-checkstyle-plugin.version}</checkstyle.version>
<puppycrawl-tools-checkstyle.version>8.43</puppycrawl-tools-checkstyle.version>
<spring-javaformat.version>0.0.26</spring-javaformat.version>
<puppycrawl-tools-checkstyle.version>9.2.1</puppycrawl-tools-checkstyle.version>
<spring-javaformat.version>0.0.35</spring-javaformat.version>
<maven-failsafe-plugin.version>2.22.2</maven-failsafe-plugin.version>
<maven-javadoc-plugin.version>3.3.0</maven-javadoc-plugin.version>
<maven-javadoc-plugin.version>3.3.1</maven-javadoc-plugin.version>
<maven-source-plugin.version>3.2.1</maven-source-plugin.version>
<maven-jar-plugin.version>3.2.0</maven-jar-plugin.version>
<maven-jar-plugin.version>3.2.2</maven-jar-plugin.version>
<maven-antrun-plugin.version>3.0.0</maven-antrun-plugin.version>
<maven-surefire-plugin.version>2.22.2</maven-surefire-plugin.version>
<maven-surefire-report-plugin.version>2.22.2</maven-surefire-report-plugin.version>
<maven-war-plugin.version>3.3.1</maven-war-plugin.version>
<exec-maven-plugin.version>1.6.0</exec-maven-plugin.version>
<maven-war-plugin.version>3.3.2</maven-war-plugin.version>
<exec-maven-plugin.version>3.0.0</exec-maven-plugin.version>
<maven-resources-plugin.version>3.2.0</maven-resources-plugin.version>
<git-commit-id-plugin.version>4.0.5</git-commit-id-plugin.version>
<git-commit-id-plugin.version>4.9.10</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-enforcer-plugin.version>3.0.0</maven-enforcer-plugin.version><!-- @releaser:version-check-off -->
<maven-gpg-plugin.version>3.0.1</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>
<artifactory-maven-plugin.version>3.2.0</artifactory-maven-plugin.version>
<artifactory-maven-plugin.version>3.2.3</artifactory-maven-plugin.version>
<license-maven-plugin.version>2.0.0</license-maven-plugin.version>
<spring-javaformat-checkstyle.version>0.0.26</spring-javaformat-checkstyle.version>
<spring-javaformat-checkstyle.version>0.0.35</spring-javaformat-checkstyle.version>
<maven-checkstyle-plugin.version>3.1.2</maven-checkstyle-plugin.version>
<pitest-maven.version>1.6.7</pitest-maven.version>
<pitest-junit5-plugin.version>0.14</pitest-junit5-plugin.version>
<pitest-maven.version>1.7.3</pitest-maven.version>
<pitest-junit5-plugin.version>0.15</pitest-junit5-plugin.version>
<disable.checks>false</disable.checks>
<maven-checkstyle-plugin.failsOnError>true</maven-checkstyle-plugin.failsOnError>
<maven-checkstyle-plugin.failOnViolation>true
@@ -91,6 +87,7 @@
</maven-checkstyle-plugin.includeTestSourceDirectory>
<spring-cloud-build-checkstyle.branch>master
</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>
@@ -100,7 +97,7 @@
<checkstyle.additional.suppressions.file>
${maven.multiModuleProjectDirectory}/src/checkstyle/checkstyle-suppressions.xml
</checkstyle.additional.suppressions.file>
<nohttp-checkstyle.version>0.0.7</nohttp-checkstyle.version>
<nohttp-checkstyle.version>0.0.10</nohttp-checkstyle.version>
<disable.nohttp.checks>true</disable.nohttp.checks>
<antelopetasks.version>3.2.10</antelopetasks.version>
<ant-nodeps.version>1.8.1</ant-nodeps.version>
@@ -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>
@@ -121,7 +119,7 @@
<readme.main.classpath>${docs.classes.dir}</readme.main.classpath>
<readme.class.path>readme.class.path</readme.class.path>
<sonar-jacoco-listeners.version>5.14.0.18788</sonar-jacoco-listeners.version>
<duplicate-finder-maven-plugin.version>1.5.0</duplicate-finder-maven-plugin.version>
<duplicate-finder-maven-plugin.version>1.5.1</duplicate-finder-maven-plugin.version>
<duplicate-finder-maven-plugin.printEqualFiles>false</duplicate-finder-maven-plugin.printEqualFiles>
<duplicate-finder-maven-plugin.failBuildInCaseOfDifferentContentConflict>false</duplicate-finder-maven-plugin.failBuildInCaseOfDifferentContentConflict>
<duplicate-finder-maven-plugin.failBuildInCaseOfEqualContentConflict>false</duplicate-finder-maven-plugin.failBuildInCaseOfEqualContentConflict>
@@ -139,6 +137,10 @@
<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>
<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>
@@ -376,6 +378,7 @@
<excludes>
<exclude>**/Abstract*.java</exclude>
</excludes>
<argLine>--add-opens=java.base/java.net=ALL-UNNAMED</argLine>
</configuration>
</plugin>
<plugin>
@@ -839,7 +842,7 @@
<executions>
<execution>
<id>sign-artifacts</id>
<phase>verify</phase>
<phase>${maven-gpg-plugin.phase}</phase>
<goals>
<goal>sign</goal>
</goals>
@@ -1052,25 +1055,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 +1102,7 @@
</artifactId>
<version>${spring-cloud-build.version}
</version>
<classifier>${spring-cloud-build-docs-classifier}</classifier>
<type>jar</type>
</dependency>
</dependencies>
@@ -1138,14 +1123,9 @@
<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>
<groupId>io.spring.asciidoctor.backends</groupId>
<artifactId>spring-asciidoctor-backends</artifactId>
<version>${spring-asciidoctor-backends.version}</version>
</dependency>
<dependency>
<groupId>org.asciidoctor</groupId>
@@ -1207,6 +1187,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 +1197,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>
@@ -1232,14 +1213,14 @@
<attributes>
<docinfo>shared</docinfo>
<stylesdir>css/</stylesdir>
<stylesheet>spring.css</stylesheet>
<stylesheet>site.css</stylesheet>
<linkcss>true</linkcss>
<icons>font</icons>
<highlightjsdir>js/highlight</highlightjsdir>
<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,24 +1232,24 @@
</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>
<stylesheet>site.css</stylesheet>
<linkcss>true</linkcss>
<icons>font</icons>
<highlightjsdir>js/highlight</highlightjsdir>
@@ -1279,7 +1260,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 +1344,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 +1364,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 +1462,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>
@@ -1528,7 +1531,7 @@
<plugin>
<groupId>org.jacoco</groupId>
<artifactId>jacoco-maven-plugin</artifactId>
<version>0.8.5</version>
<version>0.8.7</version>
<configuration>
<destFile>${sonar.jacoco.reportPath}</destFile>
<append>true</append>
@@ -1632,5 +1635,20 @@
</plugins>
</build>
</profile>
<profile>
<id>CI</id>
<activation>
<property>
<name>env.GITHUB_API_URL</name>
</property>
</activation>
<properties>
<!-- 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>
+3 -3
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</version>
<version>4.0.5</version>
<name>spring-cloud-build-dependencies</name>
<packaging>pom</packaging>
<description>Spring Cloud Build Dependencies: an internal BOM for use with Spring
@@ -14,12 +14,12 @@
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-dependencies</artifactId>
<version>2.6.3</version>
<version>3.0.9</version>
<relativePath/>
</parent>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<spring-boot.version>2.6.3</spring-boot.version>
<spring-boot.version>3.0.9</spring-boot.version>
<maven-gpg-plugin.version>3.0.1</maven-gpg-plugin.version>
</properties>
<build>
+1 -1
View File
@@ -10,7 +10,7 @@
<parent>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-build</artifactId>
<version>3.1.1</version>
<version>4.0.5</version>
</parent>
<dependencies>
<dependency>
+1 -1
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</version>
<version>4.0.5</version>
<artifactId>spring-cloud-dependencies-parent</artifactId>
<packaging>pom</packaging>
<name>spring-cloud-dependencies-parent</name>