Generate the detekt config in a task so it survives configuration cache reuse#10
Merged
Merged
Conversation
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.
What changed
Why
The config was written as a side effect during project configuration, and the detekt tasks just pointed their --config at it. When the configuration cache is reused the configuration phase is skipped, so the write never happens. On a fresh checkout that restored only the Gradle home and not build/ (a CI runner with gradle/actions/setup-gradle and a cache-encryption-key), every detekt task then failed with "Path '.../build/tmp/eignex-detekt.yml' passed to --config does not exist". Making generation a task puts it in the task graph, where it runs on every build including configuration-cache hits, and makes the output up-to-date-checkable and cacheable.
Testing
Ran the lint plugin TestKit suite (5 tests) green. Confirmed the new test fails without the plugin change (reproduces the missing-config failure) and passes with it. Verified a negative sample still fires UnnecessaryFullyQualifiedName, and that a positive sample run twice with --configuration-cache reports "Configuration cache entry stored" then "Configuration cache entry reused".