@@ -14,6 +14,10 @@ Always use the Gradle wrapper from the repository root:
1414Prerequisites for most commands:
1515- ` JAVA_HOME ` should be set to JDK 21 or later. GraalVM is recommended to match CI.
1616- Docker (required for pulling/using allowed images during tests).
17+ - [ ` grype ` ] ( https://github.com/anchore/grype ) version 0.104.0 for scanning docker images:
18+ ``` console
19+ curl -sSfL https://get.anchore.io/grype/v0.104.0/install.sh | sudo sh -s -- -b /usr/local/bin
20+ ```
1721
1822Tip: When debugging locally, add `--stacktrace` for better error output.
1923
@@ -51,7 +55,7 @@ For a single coordinate, CI runs three steps in this order:
5155To exercise many tests at once, you can target all coordinates or a slice of the test space via the N/M shard syntax.
5256
5357All coordinates:
54- 1. Pull Docker images :
58+ 1. Test the whole repo :
5559 ```console
5660 ./gradlew pullAllowedDockerImages --coordinates=all
5761 ./gradlew checkMetadataFiles --coordinates=all
@@ -88,20 +92,15 @@ These tasks support the scheduled workflow that checks newer upstream library ve
8892
89932. Mark a new tested version for a library
9094 ```console
91- ./gradlew addTestedVersion --coordinates ="group:artifact:newVersion" --lastSupportedVersion="oldVersion"`
95+ ./gradlew addTestedVersion -Pcoordinates ="group:artifact:newVersion" --lastSupportedVersion="oldVersion"
9296 ```
9397 For example:
9498 ```console
95- ./gradlew addTestedVersion --coordinates ="org.postgresql:postgresql:42.7.4" --lastSupportedVersion="42.7.3"
99+ ./gradlew addTestedVersion -Pcoordinates ="org.postgresql:postgresql:42.7.4" --lastSupportedVersion="42.7.3"
96100 ```
97101
98102### Releases and Packaging
99103
100- Run style/format checks first:
101- ``` console
102- ./gradlew spotlessCheck
103- ```
104- Then package:
105104``` console
106105./gradlew package
107106```
@@ -110,9 +109,9 @@ Then package:
110109
111110- Style: ` ./gradlew checkstyle `
112111- Format check: ` ./gradlew spotlessCheck `
113- - Pull images (single lib): ` ./gradlew pullAllowedDockerImages --coordinates=group:artifact:version `
114- - Check metadata (single lib): ` ./gradlew checkMetadataFiles --coordinates=group:artifact:version `
115- - Test (single lib): ` ./gradlew test --coordinates=group:artifact:version `
112+ - Pull images (single lib): ` ./gradlew pullAllowedDockerImages --coordinates=[ group:artifact:version|k/n|all] `
113+ - Check metadata (single lib): ` ./gradlew checkMetadataFiles --coordinates=[ group:artifact:version|k/n|all] `
114+ - Test (single lib): ` ./gradlew test --coordinates=[ group:artifact:version|k/n|all] `
116115- Scan changed Docker images: ` ./gradlew checkAllowedDockerImages --baseCommit=<sha1> --newCommit=<sha2> `
117116- Scan all Docker images: ` ./gradlew checkAllowedDockerImages `
118117- List libs with newer versions: ` ./gradlew fetchExistingLibrariesWithNewerVersions --quiet `
0 commit comments