SOLR-18302: dependency-analysis (DAGP) — reporting + build hygiene #4612
+155
−106
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| # See https://github.com/apache/solr/blob/main/dev-docs/changelog.adoc | ||
|
|
||
| title: > | ||
| Add dependency-analysis (build-health) reporting to the Gradle build in report-not-fail mode, | ||
| and apply its safe advice (unused-dependency removals and test-scope corrections) | ||
| type: other | ||
| authors: | ||
| - name: Serhiy Bzhezytskyy | ||
| links: | ||
| - name: SOLR-18302 | ||
| url: https://issues.apache.org/jira/browse/SOLR-18302 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -112,8 +112,14 @@ allprojects { | |
| // Resolve and update locks only if --write-locks explicitly included | ||
| // This may not be the case where this task is added as a dependency, like for "dependencies" task | ||
| project.configurations.findAll { | ||
| // Add any custom filtering on the configurations to be resolved. | ||
| // Skip the dependency-analysis plugin's synthetic configurations (marked with "dagp.*" | ||
| // attributes); they are not meant to be resolved and would fail lock-file generation. | ||
| // Skip spotless's own tool-resolution configurations; their formatter dependencies | ||
| // don't belong in the project's dependency lock files. | ||
| it.canBeResolved && | ||
| !it.attributes.keySet().any {attr -> attr.name.startsWith("dagp.")} && | ||
| !it.name.startsWith("spotless") | ||
|
Contributor
There was a problem hiding this comment. CC @malliaridis you might want to know about this line I added to get unstable spotless configuration noise out of the lockfile |
||
| }.each {it.resolve()} | ||
| } | ||
| } | ||
|
|
||
|
Contributor
There was a problem hiding this comment. @malliaridis this PR and another I have will add more Kotlin formatted build files. Our |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You under the Apache License, Version 2.0 | ||
| * (the "License"); you may not use this file except in compliance with | ||
| * the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| import com.autonomousapps.DependencyAnalysisExtension | ||
|
|
||
| // See dev-docs/gradle-help/dependencies.txt | ||
|
|
||
| // Opt-in only: not wired into "check", since the advice needs human judgment | ||
| tasks.register("analyzeDependencies") { | ||
| group = "verification" | ||
| description = | ||
| "Reports dependency-analysis (DAGP) advice: unused/undeclared/misconfigured dependencies." | ||
| dependsOn(tasks.named("buildHealth")) // non-obvious name | ||
| } | ||
|
|
||
| configure<DependencyAnalysisExtension> { | ||
| issues { | ||
| project(":solr:ui") { | ||
| onUnusedDependencies { | ||
| severity("ignore") | ||
| } | ||
| onUsedTransitiveDependencies { | ||
| severity("ignore") | ||
| } | ||
| onIncorrectConfiguration { | ||
| severity("ignore") | ||
| } | ||
| } | ||
|
|
||
| project(":solr:solrj-jetty") { | ||
| onUnusedDependencies { | ||
| exclude(":solr:solrj") | ||
| } | ||
| } | ||
|
|
||
| project(":solr:modules:jwt-auth") { | ||
| onDuplicateClassWarnings { | ||
| severity("ignore") | ||
| } | ||
| } | ||
|
|
||
| all { | ||
| // Report advice as warnings rather than failing the build: several categories | ||
| // (api-vs-implementation promotions, some test-scope changes) need case-by-case | ||
| // human judgment. | ||
| onAny { | ||
| severity("warn") | ||
| } | ||
| onUnusedDependencies { | ||
| exclude( | ||
| "org.jspecify:jspecify", | ||
| "com.google.code.findbugs:jsr305", | ||
| "com.google.errorprone:error_prone_annotations", | ||
| ) | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I suspect you are using AI to create these files, and that AI is not using the Gradle tasks we've built & documented (including AGENTS.md) to create them. I can tell because the file doesn't match the pattern that tool creates. Same with your GJF upgrade. Not a problem but...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks, checking...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, fair — I did hand-create these rather than run writeChangelog. I'll regenerate them with the task so they match.