-
Notifications
You must be signed in to change notification settings - Fork 174
/
Copy pathAndroidGradlePluginVersion.md.html
150 lines (128 loc) · 5.73 KB
/
AndroidGradlePluginVersion.md.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
<meta charset="utf-8">
(#) Obsolete Android Gradle Plugin Version
!!! WARNING: Obsolete Android Gradle Plugin Version
This is a warning.
Id
: `AndroidGradlePluginVersion`
Summary
: Obsolete Android Gradle Plugin Version
Severity
: Warning
Category
: Correctness
Platform
: Android
Vendor
: Android Open Source Project
Feedback
: https://issuetracker.google.com/issues/new?component=192708
Since
: Initial
Affects
: Gradle build files and TOML files
Editing
: This check runs on the fly in the IDE editor
Implementation
: [Source Code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-checks/src/main/java/com/android/tools/lint/checks/GradleDetector.kt)
Tests
: [Source Code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-tests/src/test/java/com/android/tools/lint/checks/GradleDetectorTest.kt)
Copyright Year
: 2014
This detector looks for usage of the Android Gradle Plugin where the
version you are using is not the current stable release. Using older
versions is fine, and there are cases where you deliberately want to
stick with an older version. However, you may simply not be aware that a
more recent version is available, and that is what this lint check helps
find.
!!! Tip
This lint check has an associated quickfix available in the IDE.
(##) Example
Here is an example of lint warnings produced by this check:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~text
../gradle/libs.versions.toml:8:Warning: A newer version of
com.android.application than 8.0.0 is available: 8.0.2
[AndroidGradlePluginVersion]
gradlePlugins-agp = "8.0.0"
-------
../gradle/libs.versions.toml:9:Warning: A newer version of
com.android.application than 8.1.0-alpha01 is available: 8.1.0-rc01
[AndroidGradlePluginVersion]
gradlePlugins-agp-alpha = "8.1.0-alpha01"
---------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Here is the source file referenced above:
`../gradle/libs.versions.toml`:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~toml linenumbers
[versions]
guavaVersion = "11.0.2"
appCompatVersion="13.0.0"
wearableVersion=" 1.2.0 "
# Test comment suppression:
#noinspection GradleDependency
multi-dex="1.0.0"
gradlePlugins-agp = "8.0.0"
gradlePlugins-agp-alpha = "8.1.0-alpha01"
gradlePlugins-agp-dev = "8.2.0-dev"
gradlePlugins-crashlytics = "2.9.2"
gradlePlugins-dependency-analysis = "1.0.0"
[libraries]
com-google-guava = { module = "com.google.guava:guava", version.ref = "guavaVersion"}
appcompat = { module = "com.android.support:appcompat-v7", version.ref = "appCompatVersion" }
wearable-support = { group = " com.google.android.support ", name =" wearable ", version.ref = " wearableVersion " }
multidex-lib = { module = "com.android.support:multidex", version.ref = "multi-dex" }
[bundles]
misc = [
"com-google-guava",
"appcompat",
]
[plugins]
android-application = { id = "com.android.application", version.ref = "gradlePlugins-agp" }
android-application2 = { id = "com.android.application", version.ref = "gradlePlugins-agp-alpha" }
android-application3 = { id = "com.android.application", version.ref = "gradlePlugins-agp-dev" }
crashlytics = { id = "com.google.firebase.crashlytics", version.ref = "gradlePlugins-crashlytics" }
dependency-analysis = { id = "com.autonomousapps.dependency-analysis", version.ref = "gradlePlugins-dependency-analysis" }
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
You can also visit the
[source code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-tests/src/test/java/com/android/tools/lint/checks/GradleDetectorTest.kt)
for the unit tests for this check to see additional scenarios.
The above example was automatically extracted from the first unit test
found for this lint check, `GradleDetector.testTomlVersionCatalogFile`.
To report a problem with this extracted sample, visit
https://issuetracker.google.com/issues/new?component=192708.
(##) Suppressing
You can suppress false positives using one of the following mechanisms:
* Using a suppression comment like this on the line above:
```kt
//noinspection AndroidGradlePluginVersion
problematicStatement()
```
* Using a special `lint.xml` file in the source tree which turns off
the check in that folder and any sub folder. A simple file might look
like this:
```xml
<?xml version="1.0" encoding="UTF-8"?>
<lint>
<issue id="AndroidGradlePluginVersion" severity="ignore" />
</lint>
```
Instead of `ignore` you can also change the severity here, for
example from `error` to `warning`. You can find additional
documentation on how to filter issues by path, regular expression and
so on
[here](https://googlesamples.github.io/android-custom-lint-rules/usage/lintxml.md.html).
* In Gradle projects, using the DSL syntax to configure lint. For
example, you can use something like
```gradle
lintOptions {
disable 'AndroidGradlePluginVersion'
}
```
In Android projects this should be nested inside an `android { }`
block.
* For manual invocations of `lint`, using the `--ignore` flag:
```
$ lint --ignore AndroidGradlePluginVersion ...`
```
* Last, but not least, using baselines, as discussed
[here](https://googlesamples.github.io/android-custom-lint-rules/usage/baselines.md.html).
<!-- Markdeep: --><style class="fallback">body{visibility:hidden;white-space:pre;font-family:monospace}</style><script src="markdeep.min.js" charset="utf-8"></script><script src="https://morgan3d.github.io/markdeep/latest/markdeep.min.js" charset="utf-8"></script><script>window.alreadyProcessedMarkdeep||(document.body.style.visibility="visible")</script>