Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gradle/android-cache-fix-gradle-plugin
Gradle plugin that fixes Android build caching problems.
https://github.com/gradle/android-cache-fix-gradle-plugin
android gradle
Last synced: about 1 month ago
JSON representation
Gradle plugin that fixes Android build caching problems.
- Host: GitHub
- URL: https://github.com/gradle/android-cache-fix-gradle-plugin
- Owner: gradle
- License: apache-2.0
- Created: 2017-11-02T15:16:25.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2024-06-11T17:10:41.000Z (5 months ago)
- Last Synced: 2024-06-12T23:47:28.743Z (5 months ago)
- Topics: android, gradle
- Language: Groovy
- Homepage: https://plugins.gradle.org/plugin/org.gradle.android.cache-fix
- Size: 2.57 MB
- Stars: 476
- Watchers: 30
- Forks: 46
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> _This repository is maintained by the Develocity Solutions team, as one of several publicly available repositories:_
> - _[Develocity Build Configuration Samples][develocity-build-config-samples]_
> - _[Develocity Build Validation Scripts][develocity-build-validation-scripts]_
> - _[Develocity Open Source Projects][develocity-oss-projects]_
> - _[Common Custom User Data Maven Extension][ccud-maven-extension]_
> - _[Common Custom User Data Gradle Plugin][ccud-gradle-plugin]_
> - _[Android Cache Fix Gradle Plugin][android-cache-fix-plugin] (this repository)_
# Android Cache Fix Gradle Plugin
[](https://github.com/gradle/android-cache-fix-gradle-plugin/actions/workflows/build-verification.yml)
[](https://plugins.gradle.org/plugin/org.gradle.android.cache-fix)
[](https://ge.solutions-team.gradle.com/scans)
Some Android plugin versions have issues with Gradle's build cache feature. When applied to an Android project this plugin applies workarounds for these issues based on the Android plugin and Gradle versions. For other versions, please see [older versions.](#older-android-gradle-plugin-versions)
* Supported Gradle versions: 7.0+
* Supported Android Gradle Plugin versions: 7.0+, including alpha, beta, and rc versions
* Supported Kotlin versions: 1.7.0+
We only test against the latest patch versions of each minor version of Android Gradle Plugin. This means that although it may work perfectly well with an older patch version (say 7.0.1), we do not test against these older patch versions, so the latest patch version is the only version from that minor release that we technically support.
The Android cache fix plugin is compatible with the [Gradle Configuration Cache](https://docs.gradle.org/current/userguide/configuration_cache.html#header) when used in conjunction with Android Gradle Plugin 4.2.0 and above. Using the configuration cache with earlier versions of the Android Gradle Plugin is not supported.
## Should I use this?
Take a look at the [list of issues](#list-of-issues) especially [unresolved issues](#unresolved-issues). If any of these apply to your project, you can use this plugin to solve them.
## How can I discover issues?
You can discover issues by using the task input comparison tool in Develocity. More information about [how to diagnose cache misses here](https://docs.gradle.com/enterprise/tutorials/task-inputs-comparison/). You can compare the inputs of a build that seeds the build cache - typically CI - with a build that consumes from the build cache like a local developer build.
If you discover an issue related to the Android Gradle Plugin, please file an issue in the [Android Bug Tracker](https://source.android.com/setup/contribute/report-bugs). You can also file an [issue here](https://github.com/gradle/android-cache-fix-gradle-plugin/issues) and we can see if a workaround is possible.
## Applying the plugin
This plugin should be applied anywhere the `com.android.application` or `com.android.library` plugins are applied. We recommend adding the plugin to your project's [conventions plugin](https://docs.gradle.org/current/samples/sample_convention_plugins.html).
Kotlin
```kotlin
// in build.grade.kts for convention plugin build
dependencies {
// ...
implementation("org.gradle.android.cache-fix:org.gradle.android.cache-fix.gradle.plugin:3.0.1")
// ...
}
// in com.myconventions.build.gradle.kts
plugins {
id("com.android.application") // or "com.android.library"
// Add this next line to your existing convention plugin.
id("org.gradle.android.cache-fix")
}
```
Groovy
```groovy
// in build.grade for convention plugin build
dependencies {
// ...
implementation("org.gradle.android.cache-fix:org.gradle.android.cache-fix.gradle.plugin:3.0.1")
// ...
}
// in com.myconventions.build.gradle
plugins {
id 'com.android.application' // or 'com.android.library'
// Add this next line to your existing convention plugin.
id 'org.gradle.android.cache-fix'
}
```
If you are not using convention plugins and would like a quick way of testing the plugin you can alternatively place it in the root project's build.gradle (change '3.0.1' to the latest version of the cache fix plugin
[here](https://plugins.gradle.org/plugin/org.gradle.android.cache-fix)). We discourage this approach because it uses [cross project configuration](https://docs.gradle.org/current/userguide/sharing_build_logic_between_subprojects.html#sec:convention_plugins_vs_cross_configuration).
Kotlin
```kotlin
plugins {
id("org.gradle.android.cache-fix") version "3.0.1" apply false
}
subprojects {
plugins.withType() {
apply(plugin = "org.gradle.android.cache-fix")
}
}
```
Groovy
```groovy
plugins {
id "org.gradle.android.cache-fix" version "3.0.1" apply false
}
subprojects {
plugins.withType(com.android.build.gradle.api.AndroidBasePlugin) {
project.apply plugin: "org.gradle.android.cache-fix"
}
}
```
## List of issues
You can take a look at the list of issues that the plugin fixes by looking at the classes in [`org.gradle.android.workarounds`](https://github.com/gradle/android-cache-fix-gradle-plugin/blob/master/src/main/groovy/org/gradle/android/workarounds). It contains a number of `Workaround` implementations annotated with `@AndroidIssue`. The Javadoc has a short description of the problem, and the annotation gives information about when the problem was introduced, what is the first version of the Android plugin that fixes it, and there's a link to the issue on Android's issue tracker:
```groovy
/**
* Fix {@link org.gradle.api.tasks.compile.CompileOptions#getBootClasspath()} introducing relocatability problems for {@link AndroidJavaCompile}.
*/
@AndroidIssue(introducedIn = "3.0.0", fixedIn = "3.1.0-alpha06", link = "https://issuetracker.google.com/issues/68392933")
static class AndroidJavaCompile_BootClasspath_Workaround implements Workaround {
// ...
}
```
### Unresolved Issues
***Please vote for the linked issues if you are experiencing them in your project.***
Fixed by the Android Cache Fix plugin, but unresolved in any current or upcoming preview release of the Android Gradle Plugin:
Not fixed by the Android Cache Fix plugin since it has no workaround:
* CompileLibraryResourcesTask outputs contain absolute paths: https://issuetracker.google.com/issues/282761461
Not fixed by the Android Cache Fix plugin since it has no workaround but is fixed in Android Gradle Plugin 8.0.0 or newer:
* MergeResources is not relocatable: https://issuetracker.google.com/issues/246529491
### Room
The Room annotation processor causes cache misses: https://issuetracker.google.com/issues/132245929.
To work around this issue, please apply the [Room Gradle Plugin](https://developer.android.com/jetpack/androidx/releases/room#gradle-plugin).
## Implementation Notes
### MergeNativeLibs, StripDebugSymbols, MergeJavaResources, MergeSourceSetFolders, BundleLibraryClassesJar, DataBindingMergeDependencyArtifacts, LibraryJniLibs and ZipMerging Workarounds
It has been observed that caching the `MergeNativeLibsTask`, `StripDebugSymbols`, `MergeSourceSetFolders`, `BundleLibraryClassesJar`, `DataBindingMergeDependencyArtifacts`, `LibraryJniLibs` and `ZipMergingTask` tasks rarely provide any significant positive avoidance savings. In fact, they frequently provide negative savings, especially when fetched from a remote cache node. As such, these workarounds disable caching for these tasks.
### Older Android Gradle Plugin Versions
Use Android Cache Fix Plugin 2.4.6 when using an older Android Gradle Plugin version.
* Supported Gradle versions: 5.4.1+
* Supported Android Gradle Plugin versions: 3.5.4, 3.6.4, 4.0.1, 4.1.3, 4.2.2
### Older Kotlin Gradle Plugin Versions
Use Android Cache Fix Plugin 2.6.0 when using an older Kotlin Gradle Plugin version.
* Supported Kotlin versions: \[1.3.72-1.5.32\]
## Learn more
Visit our website to learn more about [Develocity][develocity].
## License
The Android Cache Fix Gradle plugin is open-source software released under the [Apache 2.0 License][apache-license].
[develocity-build-config-samples]: https://github.com/gradle/develocity-build-config-samples
[develocity-build-validation-scripts]: https://github.com/gradle/gradle-enterprise-build-validation-scripts
[develocity-oss-projects]: https://github.com/gradle/develocity-oss-projects
[ccud-gradle-plugin]: https://github.com/gradle/common-custom-user-data-gradle-plugin
[ccud-maven-extension]: https://github.com/gradle/common-custom-user-data-maven-extension
[android-cache-fix-plugin]: https://github.com/gradle/android-cache-fix-gradle-plugin
[develocity]: https://gradle.com/develocity
[apache-license]: https://www.apache.org/licenses/LICENSE-2.0.html