Skip to content

Commit

Permalink
Merge pull request #30 from gradle/lptr/update-readme
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
lptr authored Jan 12, 2018
2 parents 3d7f20c + 0d63ba8 commit 30390df
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,19 @@

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.

* Supported Gradle versions: 4.1+
* Supported Android versions: 3.0.0, 3.1.0-alpha05
* Supported Gradle versions: 4.1 to 4.4.1
* Supported Android versions: 3.0.0, 3.1.0-alpha07

## List of issues

You can take a look at the list of issues that the plugin fixes by looking at the code of [`AndroidCacheFixPlugin`](https://github.com/gradle/android-cache-fix-gradle-plugin/blob/master/src/main/groovy/org/gradle/android/AndroidCacheFixPlugin.groovy) itself. 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 {
// ...
}
```

0 comments on commit 30390df

Please sign in to comment.