-
Notifications
You must be signed in to change notification settings - Fork 4.1k
Fix configuration cache on local builds #2032
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
by applying the OSS Licenses plugin only on CI builds. Closes android#2031
Summary of ChangesHello @SimonMarquis, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request resolves a configuration cache issue impacting local builds by modifying how the Google OSS Licenses plugin is applied. It ensures the plugin is only active within CI environments, preventing local build performance degradation and enhancing the developer experience by maintaining a clean configuration cache. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
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.
Code Review
This pull request aims to fix configuration cache issues on local builds by conditionally applying the Google OSS Licenses plugin. While the idea is correct, the implementation uses providers.gradleProperty("CI").isPresent, which is incompatible with Gradle's configuration cache and would prevent it from working on local builds. I've provided a detailed comment explaining the issue and suggesting a more robust, cache-friendly alternative using a Gradle init script for CI builds.
|
|
||
| // Apply Google's OSS Licenses plugin only on CI to avoid breaking configuration cache on local builds | ||
| // https://github.com/google/play-services-plugins/issues/246 | ||
| if (providers.gradleProperty("CI").isPresent) apply(plugin = "com.google.android.gms.oss-licenses-plugin") |
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.
While this change correctly intends to apply the OSS licenses plugin only on CI, the use of providers.gradleProperty("CI").isPresent is unfortunately not compatible with Gradle's configuration cache.
According to the Gradle documentation, Provider.isPresent() should not be used. The configuration cache engine cannot track the reason for a property's absence, which prevents it from safely reusing a cached configuration. This will likely cause the configuration cache to be disabled on every local build, negating the benefit of this PR.
A more configuration-cache-friendly approach is to move the conditional logic outside of the build script. For example, you could use a separate init script on your CI server to apply the plugin.
- Remove this conditional logic from
AndroidApplicationConventionPlugin.kt. - Create an init script, e.g.,
scripts/ci.gradle.kts:// scripts/ci.gradle.kts allprojects { plugins.withId("com.android.application") { apply(plugin = "com.google.android.gms.oss-licenses-plugin") } }
- In your CI configuration, apply this script when running Gradle:
./gradlew build --init-script scripts/ci.gradle.kts
This approach keeps the main build logic clean and cacheable, while isolating the CI-specific configuration.
by applying the OSS Licenses plugin only on CI builds.
Closes #2031