Fix compatibility with Gradle's configuration cache #538
Conversation
This file contains 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 commit is a potential breaking change: it converts the publishing plugin to Java (to make things easier to maintain), and removed in the process support for the `extraPomInfo`, `startPomInfo` and `pomInfo` closures which were used to tweak the generated pom files. If tweaking is required, then this must be done via the type-safe API instead. Relates to #536
This was a bit tricky, because we defer configuraton of the model until the task is actually required (via our model builder). This caused a number of things to be captured by the configuration cache, like the extension, version catalog, or even project. The solution was to use providers, so that the result of the provider can be serialized.
It seems that the Groovy closures which are serialized by the configuration cache do not resolve properly the delegates, leading to strange errors like `logger` not found or `versionsJson` not found.
alvarosanchez
approved these changes
Mar 10, 2023
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.
This pull request fixes our build plugins compatibility with Gradle's build cache. This is not intended for users, but really for our own builds. It should be of best interest in the IDE, when running tests (although I don't know if there's an option to only enable it when running in the IDE).
To test the changes, I have executed the build on Micronaut Test Resources. I was able to successfully:
check, however, will not fail but will not make use of the configuration cache because of this Spotless issue : https://ge.micronaut.io/s/m3xlimyljigcqNote that
--configuration-cacheis not meant to be used on CI, at least for now, since it would shave a few seconds at best, but we would still have to cache the configuration cache (maybe the Gradle GitHub action does that already, I didn't check).IMPORTANT: This refactor also removes support for
extraPomInfo,pomInfoandintroPomInfoclosures, which used to be used in Micronaut to customize the generated POM files. All customization, if ever needed, should be done via the type-safe API instead. It seems, by searching in the repositories, that onlymicronaut-helidonuses, but it's not officially maintained AFAIK and usage can be easily removed.