Skip to content

Commit 3787cf4

Browse files
committed
Merge branch 'main' into gh-3774-cors-configuration-on-redis-refresh
2 parents e8c0c60 + 5f9b46f commit 3787cf4

File tree

368 files changed

+11459
-1702
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

368 files changed

+11459
-1702
lines changed

.github/CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ author credit if we do. Active contributors might be asked to join the core tea
1616
given the ability to merge pull requests.
1717

1818
## Code of Conduct
19-
This project adheres to the Contributor Covenant [Code of conduct](https://github.com/spring-cloud/spring-cloud-build/blob/master/docs/src/main/asciidoc/code-of-conduct.adoc). By participating, you are expected to uphold this code. Please report
19+
This project adheres to the Contributor Covenant [Code of conduct](https://github.com/spring-cloud/spring-cloud-build/blob/main/docs/modules/ROOT/partials/code-of-conduct.adoc). By participating, you are expected to uphold this code. Please report
2020
unacceptable behavior to [email protected].
2121

2222
## Code Conventions and Housekeeping
@@ -41,4 +41,4 @@ added after the original pull request but before a merge.
4141
other target branch in the main project).
4242
* When writing a commit message please follow [these conventions](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html),
4343
if you are fixing an existing issue please add `Fixes gh-XXXX` at the end of the commit
44-
message (where XXXX is the issue number).
44+
message (where XXXX is the issue number).

.github/dependabot.yml

Lines changed: 21 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,10 @@
1+
# To get started with Dependabot version updates, you'll need to specify which
2+
# package ecosystems to update and where the package manifests are located.
3+
# Please see the documentation for all configuration options:
4+
# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
5+
16
version: 2
27
updates:
3-
- package-ecosystem: "github-actions"
4-
directory: "/"
5-
target-branch: "3.1.x" # oldest OSS supported branch
6-
schedule:
7-
interval: "weekly"
8-
- package-ecosystem: "github-actions"
9-
directory: "/"
10-
target-branch: "4.0.x" # oldest OSS supported branch
11-
schedule:
12-
interval: "weekly"
138
- package-ecosystem: "github-actions"
149
directory: "/"
1510
target-branch: "main"
@@ -19,31 +14,35 @@ updates:
1914
directory: /
2015
schedule:
2116
interval: daily
22-
target-branch: 3.1.x
17+
target-branch: main
2318
ignore:
24-
# only upgrade patch versions for maintenance branch
19+
# only upgrade by minor or patch
2520
- dependency-name: "*"
2621
update-types:
2722
- version-update:semver-major
28-
- version-update:semver-minor
2923
- package-ecosystem: maven
3024
directory: /
3125
schedule:
3226
interval: daily
33-
target-branch: 4.0.x
27+
target-branch: 4.1.x
3428
ignore:
35-
# only upgrade patch versions for maintenance branch
29+
# only upgrade by minor or patch
3630
- dependency-name: "*"
3731
update-types:
3832
- version-update:semver-major
3933
- version-update:semver-minor
40-
- package-ecosystem: maven
34+
- package-ecosystem: npm
35+
target-branch: docs-build
4136
directory: /
4237
schedule:
43-
interval: daily
38+
interval: weekly
39+
- package-ecosystem: npm
4440
target-branch: main
45-
ignore:
46-
# only upgrade by minor or patch
47-
- dependency-name: "*"
48-
update-types:
49-
- version-update:semver-major
41+
directory: /docs
42+
schedule:
43+
interval: weekly
44+
- package-ecosystem: npm
45+
target-branch: 4.1.x
46+
directory: /docs
47+
schedule:
48+
interval: weekly

.github/workflows/maven.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ name: Build
55

66
on:
77
push:
8-
branches: [ main, 4.1.x, 3.1.x ]
8+
branches: [ main, 4.2.x, 4.1.x, 3.1.x ]
99
pull_request:
10-
branches: [ main, 4.1.x, 3.1.x ]
10+
branches: [ main, 4.2.x, 4.1.x, 3.1.x ]
1111

1212
jobs:
1313
build:
@@ -25,7 +25,7 @@ jobs:
2525
- name: Build with Maven
2626
run: ./mvnw clean install -B -U -Pspring -Dmaven.test.redirectTestOutputToFile=true -Dmaven.wagon.http.pool=false -Dmaven.wagon.httpconnectionManager.ttlSeconds=120
2727
- name: Publish Test Report
28-
uses: mikepenz/action-junit-report@v4
28+
uses: mikepenz/action-junit-report@v5
2929
if: always() # always run even if the previous step fails
3030
with:
3131
report_paths: '**/surefire-reports/TEST-*.xml'

README.adoc

Lines changed: 86 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,92 @@ image::https://codecov.io/gh/spring-cloud/spring-cloud-gateway/branch/main/graph
2727
[[building]]
2828
= Building
2929

30-
Unresolved directive in <stdin> - include::https:///raw.githubusercontent.com/spring-cloud/spring-cloud-build/main/docs/modules/ROOT/partials/building.adoc[]
30+
:jdkversion: 17
31+
32+
[[basic-compile-and-test]]
33+
== Basic Compile and Test
34+
35+
To build the source you will need to install JDK {jdkversion}.
36+
37+
Spring Cloud uses Maven for most build-related activities, and you
38+
should be able to get off the ground quite quickly by cloning the
39+
project you are interested in and typing
40+
41+
----
42+
$ ./mvnw install
43+
----
44+
45+
NOTE: You can also install Maven (>=3.3.3) yourself and run the `mvn` command
46+
in place of `./mvnw` in the examples below. If you do that you also
47+
might need to add `-P spring` if your local Maven settings do not
48+
contain repository declarations for spring pre-release artifacts.
49+
50+
NOTE: Be aware that you might need to increase the amount of memory
51+
available to Maven by setting a `MAVEN_OPTS` environment variable with
52+
a value like `-Xmx512m -XX:MaxPermSize=128m`. We try to cover this in
53+
the `.mvn` configuration, so if you find you have to do it to make a
54+
build succeed, please raise a ticket to get the settings added to
55+
source control.
56+
57+
The projects that require middleware (i.e. Redis) for testing generally
58+
require that a local instance of [Docker](https://www.docker.com/get-started) is installed and running.
59+
60+
[[documentation]]
61+
== Documentation
62+
63+
The spring-cloud-build module has a "docs" profile, and if you switch
64+
that on it will try to build asciidoc sources using https://docs.antora.org/antora/latest/[Antora] from
65+
`modules/ROOT/`.
66+
67+
As part of that process it will look for a
68+
`docs/src/main/asciidoc/README.adoc` and process it by loading all the includes, but not
69+
parsing or rendering it, just copying it to `${main.basedir}`
70+
(defaults to `$\{basedir}`, i.e. the root of the project). If there are
71+
any changes in the README it will then show up after a Maven build as
72+
a modified file in the correct place. Just commit it and push the change.
73+
74+
[[working-with-the-code]]
75+
== Working with the code
76+
If you don't have an IDE preference we would recommend that you use
77+
https://www.springsource.com/developer/sts[Spring Tools Suite] or
78+
https://eclipse.org[Eclipse] when working with the code. We use the
79+
https://eclipse.org/m2e/[m2eclipse] eclipse plugin for maven support. Other IDEs and tools
80+
should also work without issue as long as they use Maven 3.3.3 or better.
81+
82+
[[activate-the-spring-maven-profile]]
83+
=== Activate the Spring Maven profile
84+
Spring Cloud projects require the 'spring' Maven profile to be activated to resolve
85+
the spring milestone and snapshot repositories. Use your preferred IDE to set this
86+
profile to be active, or you may experience build errors.
87+
88+
[[importing-into-eclipse-with-m2eclipse]]
89+
=== Importing into eclipse with m2eclipse
90+
We recommend the https://eclipse.org/m2e/[m2eclipse] eclipse plugin when working with
91+
eclipse. If you don't already have m2eclipse installed it is available from the "eclipse
92+
marketplace".
93+
94+
NOTE: Older versions of m2e do not support Maven 3.3, so once the
95+
projects are imported into Eclipse you will also need to tell
96+
m2eclipse to use the right profile for the projects. If you
97+
see many different errors related to the POMs in the projects, check
98+
that you have an up to date installation. If you can't upgrade m2e,
99+
add the "spring" profile to your `settings.xml`. Alternatively you can
100+
copy the repository settings from the "spring" profile of the parent
101+
pom into your `settings.xml`.
102+
103+
[[importing-into-eclipse-without-m2eclipse]]
104+
=== Importing into eclipse without m2eclipse
105+
If you prefer not to use m2eclipse you can generate eclipse project metadata using the
106+
following command:
107+
108+
[indent=0]
109+
----
110+
$ ./mvnw eclipse:eclipse
111+
----
112+
113+
The generated eclipse projects can be imported by selecting `import existing projects`
114+
from the `file` menu.
115+
31116

32117
[[contributing]]
33118
= Contributing

SECURITY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
## Reporting a Vulnerability
44

5-
To report security vulnerabilities, please go to https://pivotal.io/security.
5+
To report security vulnerabilities, please go to https://spring.io/security-policy.

0 commit comments

Comments
 (0)