Update configurations assignments and fix typos#1361
Merged
Conversation
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Goooler
commented
Mar 24, 2025
Goooler
commented
Mar 24, 2025
Goooler
commented
Mar 24, 2025
Contributor
There was a problem hiding this comment.
Pull Request Overview
This pull request updates the code examples for assigning configurations in the ShadowJar task and fixes typos in configuration names within the documentation. The changes improve consistency in API usage and correct variable naming to align with updated conventions.
- Updated Kotlin and Groovy snippets in the dependencies docs to use new methods for retrieving configurations.
- Corrected a typo in the configuration name in the publishing docs.
- Updated the custom tasks docs for configuration assignment consistency.
Reviewed Changes
Copilot reviewed 3 out of 5 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/configuration/dependencies/README.md | Updated code examples to use compileClasspath and fixed configuration typo in inline text. |
| docs/publishing/README.md | Updated configuration access for testRuntimeClasspath and fixed configuration naming. |
| docs/custom-tasks/README.md | Updated test configuration access to align with the new approach. |
Files not reviewed (2)
- src/functionalTest/kotlin/com/github/jengelman/gradle/plugins/shadow/JavaPluginTest.kt: Language not supported
- src/functionalTest/kotlin/com/github/jengelman/gradle/plugins/shadow/PublishingTest.kt: Language not supported
Comments suppressed due to low confidence (5)
docs/configuration/dependencies/README.md:12
- [nitpick] Consider using 'project.configurations.named("compileClasspath")' instead for consistency with the Groovy snippet and lazy configuration practices.
configurations = project.configurations.compileClasspath.map { listOf(it) }
docs/publishing/README.md:170
- [nitpick] Consider using 'project.configurations.named("testRuntimeClasspath")' here for a consistent approach across the different examples.
configurations = project.configurations.testRuntimeClasspath.map { listOf(it) }
docs/publishing/README.md:203
- [nitpick] Verify that the lazy configuration access using named() aligns with the project documentation conventions in all examples.
configurations = project.configurations.named('testRuntimeClasspath').map { [it] }
docs/custom-tasks/README.md:17
- [nitpick] Consider using 'project.configurations.named("testRuntimeClasspath")' for consistency with the other updated examples.
configurations = project.configurations.testRuntimeClasspath.map { listOf(it) }
docs/custom-tasks/README.md:41
- [nitpick] Confirm that the use of the named() method here is intentional and consistent with the project's overall configuration access strategy.
configurations = project.configurations.named('testRuntimeClasspath').map { [it] }
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Follow up #1306 (comment).