Skip to content

Commit 9969e2c

Browse files
authored
Update documentation to include information on release 1.5 and AGP 7 (#44)
1 parent e67de0a commit 9969e2c

File tree

2 files changed

+16
-19
lines changed

2 files changed

+16
-19
lines changed

README.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -142,26 +142,30 @@ rootCoverage {
142142

143143

144144
# 4. Compatibility
145-
| Version | Android Gradle plugin version | Gradle version |
146-
| ------------- | ----------------------------- | ----------------- |
147-
| **1.4.0** | 4.1+ | 6.5+ |
148-
| **1.3.1** | 4.0<br/>3.6 | 6.1.1+<br/>5.6.4+ |
149-
| **1.2.1** | 3.5 | 5.4.1+ |
150-
| **1.1.2** | 3.4 | 5.1.1+ |
151-
| **1.1.1** | 3.3 | 4.10.1+ |
152-
| **1.0.2** | 3.2 | 4.6+ |
145+
| Version | [Android Gradle plugin version](https://developer.android.com/studio/releases/gradle-plugin#updating-gradle) | Gradle version |
146+
| ------------------ | ------------------------------------------------------------------------------------------------------------ | ----------------- |
147+
| **1.5.0-SNAPSHOT** | 7.2-alpha06 | 7.3+ |
148+
| **See note 2** | 7.0-7.2-alpha05 | n.a. |
149+
| **1.4.0** | 4.2<br/>4.1 | 6.7.1+<br/>6.5+ |
150+
| **1.3.1** | 4.0<br/>3.6 | 6.1.1+<br/>5.6.4+ |
151+
| **1.2.1** | 3.5 | 5.4.1+ |
152+
| **1.1.2** | 3.4 | 5.1.1+ |
153+
| **1.1.1** | 3.3 | 4.10.1+ |
154+
| **1.0.2** | 3.2 | 4.6+ |
153155

154156
> *Note 1: Plugin versions below 1.3.1, such as 1.3.0, are only available on the Gradle Plugin Portal
155157
(`maven { url "https://plugins.gradle.org/m2/"}`) and not on Maven Central. These versions use the
156158
group ID `org.neotech.plugin` and plugin ID `org.neotech.plugin.rootcoverage`!*
157159

158-
> *Note 2: This plugin normally supports the same Gradle versions as the Android Gradle plugin, for more information
159-
> see:* <https://developer.android.com/studio/releases/gradle-plugin#updating-gradle>
160+
> *Note 2: Android Gradle Plugin version 7 till 7.2.0-alpha05 suffered from a
161+
[bug](https://issuetracker.google.com/issues/195860510) that caused instrumented coverage in Android library modules to fail, this has only been
162+
[fixed](https://github.com/NeoTech-Software/Android-Root-Coverage-Plugin/issues/36#issuecomment-977241070)
163+
in Android Gradle Plugin 7.2.0-alpha06. This means there is no stable working plugin version available for these AGP versions.*
160164

161-
> Note 3: Android Gradle Plugin versions before `3.4.0-alpha05` are affected by a bug that in certain conditions can
165+
> *Note 3: Android Gradle Plugin versions before `3.4.0-alpha05` are affected by a bug that in certain conditions can
162166
cause Jacoco instrumentation to fail in combination with inline kotlin methods shared across modules. For more information
163167
see: <https://issuetracker.google.com/issues/109771903> and <https://issuetracker.google.com/issues/110763361>.
164-
If your project is affected by this upgrade to an Android Gradle Plugin version of at least `3.4.0-alpha05`.
168+
If your project is affected by this upgrade to an Android Gradle Plugin version of at least `3.4.0-alpha05`.*
165169

166170

167171
# 5. Development

plugin/src/main/kotlin/org/neotech/plugin/rootcoverage/RootCoveragePlugin.kt

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -144,9 +144,6 @@ class RootCoveragePlugin : Plugin<Project> {
144144

145145

146146
private fun createSubProjectCoverageTask(subProject: Project) {
147-
// Aggregates jacoco results from the app sub-project and bankingright sub-project and generates a report.
148-
// The report can be found at the root of the project in /build/reports/jacoco, so don't look in
149-
// /app/build/reports/jacoco you will only find the app sub-project report there.
150147
val task = subProject.tasks.create("coverageReport", JacocoReport::class.java)
151148
task.group = "reporting"
152149
task.description = "Generates a Jacoco for this Gradle module."
@@ -173,10 +170,6 @@ class RootCoveragePlugin : Plugin<Project> {
173170
}
174171

175172
private fun createCoverageTaskForRoot(project: Project) {
176-
// Aggregates jacoco results from the app sub-project and bankingright sub-project and generates a report.
177-
// The report can be found at the root of the project in /build/reports/jacoco, so don't look in
178-
// /app/build/reports/jacoco you will only find the app sub-project report there.
179-
180173
val task = project.tasks.create("rootCoverageReport", JacocoReport::class.java)
181174
task.group = "reporting"
182175
task.description = "Generates a Jacoco report with combined results from all the subprojects."

0 commit comments

Comments
 (0)