mirror of
https://github.com/spring-cloud/spring-cloud-build.git
synced 2026-09-17 21:09:00 +00:00
Compare commits
160
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
23496a79be | ||
|
|
94e6807e09 | ||
|
|
baca4d23cc | ||
|
|
b528877aab | ||
|
|
f2de5d1302 | ||
|
|
10a19d7e3b | ||
|
|
c53e18927a | ||
|
|
7a6735ea04 | ||
|
|
f20e58b49c | ||
|
|
1b60c5b801 | ||
|
|
53f01d9804 | ||
|
|
413ada770c | ||
|
|
00d08e83b0 | ||
|
|
c3995a08fa | ||
|
|
a237137ed4 | ||
|
|
195ce4e753 | ||
|
|
6a8dfa60d3 | ||
|
|
21a18395fa | ||
|
|
a2e2ff90e2 | ||
|
|
d7f3a8f35d | ||
|
|
b52dff8956 | ||
|
|
4bea4c590f | ||
|
|
8087edaf9a | ||
|
|
79ec1a0b58 | ||
|
|
a14578930a | ||
|
|
6f7f008710 | ||
|
|
2701008de8 | ||
|
|
3243b7a322 | ||
|
|
cb733fd590 | ||
|
|
a6af2759db | ||
|
|
5d6caf1235 | ||
|
|
8420504e81 | ||
|
|
737a871aae | ||
|
|
240995fa09 | ||
|
|
6aa7ce8922 | ||
|
|
661a4ccb61 | ||
|
|
753c1e78db | ||
|
|
983d743cd6 | ||
|
|
d94e0350a3 | ||
|
|
04b16bd386 | ||
|
|
c34d045a87 | ||
|
|
5e60d0ba3b | ||
|
|
754ac21e0c | ||
|
|
0c8a004022 | ||
|
|
2ddad64197 | ||
|
|
b39ddf77cd | ||
|
|
aa945db6ba | ||
|
|
df48f5dd5f | ||
|
|
2742082c21 | ||
|
|
4965414a99 | ||
|
|
63c0f70252 | ||
|
|
9aad646584 | ||
|
|
4f137c8551 | ||
|
|
fe397f39b3 | ||
|
|
7af9936776 | ||
|
|
802459a94d | ||
|
|
2da5576afc | ||
|
|
fec1fd6592 | ||
|
|
fee3542395 | ||
|
|
389e806ab4 | ||
|
|
7db0179851 | ||
|
|
60fd117a72 | ||
|
|
9ba1bd0004 | ||
|
|
d0a0fcbe55 | ||
|
|
8824d89285 | ||
|
|
410e50327a | ||
|
|
c7c3d42f89 | ||
|
|
674493178a | ||
|
|
3fd1f8194d | ||
|
|
ab53ece701 | ||
|
|
ed293ba424 | ||
|
|
f6fee4a4d1 | ||
|
|
0a5fc5c356 | ||
|
|
ca4c8114e0 | ||
|
|
9fa4d632f5 | ||
|
|
62bcecf8ba | ||
|
|
08179ab430 | ||
|
|
7fe9f123b9 | ||
|
|
bfbe4ab22d | ||
|
|
d944721b95 | ||
|
|
058d3d8469 | ||
|
|
4d95b4de06 | ||
|
|
1997e21fe6 | ||
|
|
cdc7b77b7c | ||
|
|
f685b9eca4 | ||
|
|
d894bb5d70 | ||
|
|
717f97b455 | ||
|
|
f9f3341bb0 | ||
|
|
4c6634771f | ||
|
|
9e17a7fc8d | ||
|
|
71ee1e08f7 | ||
|
|
480c02c009 | ||
|
|
f59d853039 | ||
|
|
c344ca06b8 | ||
|
|
a38b36105b | ||
|
|
b103fbd43f | ||
|
|
71103bacea | ||
|
|
528b03b71f | ||
|
|
a2a40673d8 | ||
|
|
8cf0076cfc | ||
|
|
a3f7ab02b9 | ||
|
|
6dcc3a8bd8 | ||
|
|
84b9735bac | ||
|
|
f1015193db | ||
|
|
059b52a282 | ||
|
|
68de0d967f | ||
|
|
7401e65427 | ||
|
|
82e6c482e0 | ||
|
|
289e87195c | ||
|
|
f024dadefa | ||
|
|
383ae64dbb | ||
|
|
db0f4d7157 | ||
|
|
8c8f591c99 | ||
|
|
20df35799d | ||
|
|
0e9ac25dd5 | ||
|
|
08e3b24a27 | ||
|
|
317da7a4e4 | ||
|
|
eca70fe4cc | ||
|
|
7e9df7fd7c | ||
|
|
82a1cf794b | ||
|
|
49dd7deec2 | ||
|
|
7108146aba | ||
|
|
8e81876fd3 | ||
|
|
95b5890066 | ||
|
|
63bd653948 | ||
|
|
cae59ec9fd | ||
|
|
009fee7f44 | ||
|
|
63aa041bbb | ||
|
|
83e6e42e54 | ||
|
|
13262df844 | ||
|
|
b83f87423b | ||
|
|
769c5e1989 | ||
|
|
5dc46d26bb | ||
|
|
ea265749fa | ||
|
|
a8d9426206 | ||
|
|
1c104f1837 | ||
|
|
119006d160 | ||
|
|
f4fa5e62cf | ||
|
|
c3ffb0a5dc | ||
|
|
55b2c63b0a | ||
|
|
7c613551d0 | ||
|
|
d48985e4fd | ||
|
|
fba352a8af | ||
|
|
ad0826c3e3 | ||
|
|
8ff3564115 | ||
|
|
1a1e2f7a45 | ||
|
|
0fbe1ca90a | ||
|
|
2830e11a3b | ||
|
|
d04bc15599 | ||
|
|
f39e225856 | ||
|
|
4aa9d8cce4 | ||
|
|
c1bb7946cc | ||
|
|
1d354900b7 | ||
|
|
2bb8d61d7d | ||
|
|
f005cfaa2b | ||
|
|
711fbce9ba | ||
|
|
84ecff1ac8 | ||
|
|
0e31343b92 | ||
|
|
592d80f379 | ||
|
|
40ae242fe8 |
@@ -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:
|
||||
|
||||
+3
-42
@@ -5,7 +5,7 @@ Edit the files in the src/main/asciidoc/ directory instead.
|
||||
////
|
||||
|
||||
|
||||
image::https://github.com/spring-cloud/spring-cloud-build/workflows/Build/badge.svg?branch=main&style=svg["Build",link="https://github.com/spring-cloud/spring-cloud-build/actions"]
|
||||
image::https://github.com/spring-cloud/spring-cloud-build/workflows/Build/badge.svg?branch=4.0.x&style=svg["Build",link="https://github.com/spring-cloud/spring-cloud-build/actions"]
|
||||
|
||||
Spring Cloud Build is a common utility project for Spring Cloud
|
||||
to use for plugin and dependency management.
|
||||
@@ -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/{spring-cloud-build-branch}/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/{spring-cloud-build-branch}/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.
|
||||
@@ -364,45 +364,6 @@ Spring Cloud Build Docs comes with a set of attributes for asciidoctor that you
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<attributes>
|
||||
<docinfo>shared</docinfo>
|
||||
<allow-uri-read>true</allow-uri-read>
|
||||
<nofooter/>
|
||||
<toc>left</toc>
|
||||
<toc-levels>4</toc-levels>
|
||||
<sectlinks>true</sectlinks>
|
||||
<sources-root>${project.basedir}/src@</sources-root>
|
||||
<asciidoc-sources-root>${project.basedir}/src/main/asciidoc@</asciidoc-sources-root>
|
||||
<generated-resources-root>${project.basedir}/target/generated-resources@
|
||||
</generated-resources-root>
|
||||
<!-- Use this attribute the reference code from another module -->
|
||||
<!-- Note the @ at the end, lowering the precedence of the attribute -->
|
||||
<project-root>${maven.multiModuleProjectDirectory}@</project-root>
|
||||
<!-- It's mandatory for you to pass the docs.main property -->
|
||||
<github-repo>${docs.main}@</github-repo>
|
||||
<github-project>https://github.com/spring-cloud/${docs.main}@</github-project>
|
||||
<github-raw>
|
||||
https://raw.githubusercontent.com/spring-cloud/${docs.main}/${github-tag}@
|
||||
</github-raw>
|
||||
<github-code>https://github.com/spring-cloud/${docs.main}/tree/${github-tag}@
|
||||
</github-code>
|
||||
<github-issues>https://github.com/spring-cloud/${docs.main}/issues/@</github-issues>
|
||||
<github-wiki>https://github.com/spring-cloud/${docs.main}/wiki@</github-wiki>
|
||||
<github-master-code>https://github.com/spring-cloud/${docs.main}/tree/master@
|
||||
</github-master-code>
|
||||
<index-link>${index-link}@</index-link>
|
||||
|
||||
<!-- Spring Cloud specific -->
|
||||
<!-- for backward compatibility -->
|
||||
<spring-cloud-version>${project.version}@</spring-cloud-version>
|
||||
<project-version>${project.version}@</project-version>
|
||||
<github-tag>${github-tag}@</github-tag>
|
||||
<version-type>${version-type}@</version-type>
|
||||
<docs-url>https://docs.spring.io/${docs.main}/docs/${project.version}@</docs-url>
|
||||
<raw-docs-url>${github-raw}@</raw-docs-url>
|
||||
<project-version>${project.version}@</project-version>
|
||||
<project-name>${docs.main}@</project-name>
|
||||
</attributes>
|
||||
----
|
||||
|
||||
== Updating the guides
|
||||
|
||||
+4
-1
@@ -10,7 +10,7 @@
|
||||
<parent>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-build</artifactId>
|
||||
<version>4.0.0-SNAPSHOT</version>
|
||||
<version>4.0.6</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 -->
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
image::https://github.com/spring-cloud/spring-cloud-build/workflows/Build/badge.svg?branch=main&style=svg["Build",link="https://github.com/spring-cloud/spring-cloud-build/actions"]
|
||||
image::https://github.com/spring-cloud/spring-cloud-build/workflows/Build/badge.svg?branch=4.0.x&style=svg["Build",link="https://github.com/spring-cloud/spring-cloud-build/actions"]
|
||||
|
||||
Spring Cloud Build is a common utility project for Spring Cloud
|
||||
to use for plugin and dependency management.
|
||||
@@ -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/4.0.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/main/pom.xml[tags=attributes,indent=0]
|
||||
----
|
||||
|
||||
== Updating the guides
|
||||
|
||||
@@ -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,4 +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/4.0.x/docs/src/main/asciidoc/building.adoc[]
|
||||
|
||||
|
||||
@@ -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/master/docs/src/main/asciidoc/building-base.adoc[]
|
||||
|
||||
@@ -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/{spring-cloud-build-branch}/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/{spring-cloud-build-branch}/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.
|
||||
|
||||
@@ -144,7 +144,7 @@ public class Main {
|
||||
}
|
||||
|
||||
public String toString() {
|
||||
return "|" + name + " | " + (StringUtils.hasText(defaultValue) ? ("`" + defaultValue + "`") : "") + " | " + description;
|
||||
return "|" + name + " | " + (StringUtils.hasText(defaultValue) ? ("`+++" + defaultValue + "+++`") : "") + " | " + description;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@@ -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/4.0.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/4.0.x/pom.xml[tags=attributes,indent=0]
|
||||
----
|
||||
|
||||
== Updating the guides
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-build</artifactId>
|
||||
<version>4.0.0-SNAPSHOT</version>
|
||||
<version>4.0.6</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>17</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>3.0.0-SNAPSHOT</spring-boot.version>
|
||||
<spring-cloud-build.version>4.0.0-SNAPSHOT</spring-cloud-build.version>
|
||||
<spring-boot.version>3.0.13</spring-boot.version>
|
||||
<spring-cloud-build.version>4.0.6</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.4</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.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>
|
||||
@@ -59,7 +55,7 @@
|
||||
<!-- for backwards compatibility, use maven-checkstyle-plugin.version -->
|
||||
<checkstyle.version>${maven-checkstyle-plugin.version}</checkstyle.version>
|
||||
<puppycrawl-tools-checkstyle.version>9.2.1</puppycrawl-tools-checkstyle.version>
|
||||
<spring-javaformat.version>0.0.29</spring-javaformat.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.1</maven-javadoc-plugin.version>
|
||||
<maven-source-plugin.version>3.2.1</maven-source-plugin.version>
|
||||
@@ -73,13 +69,13 @@
|
||||
<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</maven-enforcer-plugin.version><!-- @releaser:version-check-off -->
|
||||
<maven-gpg-plugin.version>3.2.0</maven-gpg-plugin.version>
|
||||
<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.3</artifactory-maven-plugin.version>
|
||||
<license-maven-plugin.version>2.0.0</license-maven-plugin.version>
|
||||
<spring-javaformat-checkstyle.version>0.0.29</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.7.3</pitest-maven.version>
|
||||
<pitest-junit5-plugin.version>0.15</pitest-junit5-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,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>
|
||||
@@ -1157,6 +1137,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 +1192,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 +1202,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 +1218,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 +1237,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 +1265,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 +1349,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 +1369,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 +1467,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 +1640,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>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-build-dependencies</artifactId>
|
||||
<version>4.0.0-SNAPSHOT</version>
|
||||
<version>4.0.6</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>3.0.0-SNAPSHOT</version>
|
||||
<version>3.0.13</version>
|
||||
<relativePath/>
|
||||
</parent>
|
||||
<properties>
|
||||
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
|
||||
<spring-boot.version>3.0.0-SNAPSHOT</spring-boot.version>
|
||||
<spring-boot.version>3.0.13</spring-boot.version>
|
||||
<maven-gpg-plugin.version>3.0.1</maven-gpg-plugin.version>
|
||||
</properties>
|
||||
<build>
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
<parent>
|
||||
<groupId>org.springframework.cloud</groupId>
|
||||
<artifactId>spring-cloud-build</artifactId>
|
||||
<version>4.0.0-SNAPSHOT</version>
|
||||
<version>4.0.6</version>
|
||||
</parent>
|
||||
<dependencies>
|
||||
<dependency>
|
||||
|
||||
@@ -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>4.0.0-SNAPSHOT</version>
|
||||
<version>4.0.6</version>
|
||||
<artifactId>spring-cloud-dependencies-parent</artifactId>
|
||||
<packaging>pom</packaging>
|
||||
<name>spring-cloud-dependencies-parent</name>
|
||||
|
||||
Reference in New Issue
Block a user