Skip to content

A fully functional Android app built entirely with Kotlin and Jetpack Compose

Android Lint improvements

Simon Marquis8ea9a8fa5126
diff --git a/.github/workflows/Build.yaml b/.github/workflows/Build.yaml
index a3b328dcb..a297a3ca3 100644
--- a/.github/workflows/Build.yaml
+++ b/.github/workflows/Build.yaml
@@ -36,21 +36,28 @@ jobs:
- name: Check spotless
run: ./gradlew spotlessCheck --init-script gradle/init.gradle.kts --no-configuration-cache
- - name: Check lint
- run: ./gradlew lintDemoDebug
-
- name: Build all build type and flavor permutations
run: ./gradlew assemble
- - name: Run local tests
- run: ./gradlew testDemoDebug testProdDebug
-
- name: Upload build outputs (APKs)
uses: actions/upload-artifact@v3
with:
name: APKs
path: '**/build/outputs/apk/**/*.apk'
+ - name: Run local tests
+ run: ./gradlew testDemoDebug testProdDebug
+
+ - name: Upload test results (XML)
+ if: always()
+ uses: actions/upload-artifact@v3
+ with:
+ name: test-results
+ path: '**/build/test-results/test*UnitTest/**.xml'
+
+ - name: Check lint
+ run: ./gradlew lintProdRelease
+
- name: Upload lint reports (HTML)
if: always()
uses: actions/upload-artifact@v3
@@ -58,12 +65,11 @@ jobs:
name: lint-reports
path: '**/build/reports/lint-results-*.html'
- - name: Upload test results (XML)
+ - name: Upload lint reports (SARIF)
if: always()
- uses: actions/upload-artifact@v3
+ uses: github/codeql-action/upload-sarif@v2
with:
- name: test-results
- path: '**/build/test-results/test*UnitTest/**.xml'
+ sarif_file: '**/build/reports/lint-results-*.sarif'
androidTest:
needs: build
diff --git a/build-logic/convention/build.gradle.kts b/build-logic/convention/build.gradle.kts
index c8e25e17c..9230dd6b7 100644
--- a/build-logic/convention/build.gradle.kts
+++ b/build-logic/convention/build.gradle.kts
@@ -92,6 +92,10 @@ gradlePlugin {
id = "nowinandroid.android.application.flavors"
implementationClass = "AndroidApplicationFlavorsConventionPlugin"
}
+ register("androidLint") {
+ id = "nowinandroid.android.lint"
+ implementationClass = "AndroidLintConventionPlugin"
+ }
register("jvmLibrary") {
id = "nowinandroid.jvm.library"
implementationClass = "JvmLibraryConventionPlugin"
diff --git a/build-logic/convention/src/main/kotlin/AndroidApplicationConventionPlugin.kt b/build-logic/convention/src/main/kotlin/AndroidApplicationConventionPlugin.kt
index 26b6951d3..a8bed4bec 100644
--- a/build-logic/convention/src/main/kotlin/AndroidApplicationConventionPlugin.kt
+++ b/build-logic/convention/src/main/kotlin/AndroidApplicationConventionPlugin.kt
@@ -29,6 +29,7 @@ class AndroidApplicationConventionPlugin : Plugin<Project> {
with(pluginManager) {
apply("com.android.application")
apply("org.jetbrains.kotlin.android")
+ apply("nowinandroid.android.lint")
}
extensions.configure<ApplicationExtension> {
diff --git a/build-logic/convention/src/main/kotlin/AndroidLibraryConventionPlugin.kt b/build-logic/convention/src/main/kotlin/AndroidLibraryConventionPlugin.kt
index 275a26620..83ce09324 100644
--- a/build-logic/convention/src/main/kotlin/AndroidLibraryConventionPlugin.kt
+++ b/build-logic/convention/src/main/kotlin/AndroidLibraryConventionPlugin.kt
@@ -35,6 +35,7 @@ class AndroidLibraryConventionPlugin : Plugin<Project> {
with(pluginManager) {
apply("com.android.library")
apply("org.jetbrains.kotlin.android")
+ apply("nowinandroid.android.lint")
}
extensions.configure<LibraryExtension> {
diff --git a/build-logic/convention/src/main/kotlin/AndroidLintConventionPlugin.kt b/build-logic/convention/src/main/kotlin/AndroidLintConventionPlugin.kt
new file mode 100644
index 000000000..23d8e234c
--- /dev/null
+++ b/build-logic/convention/src/main/kotlin/AndroidLintConventionPlugin.kt
@@ -0,0 +1,46 @@
+/*
+ * Copyright 2022 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import com.android.build.api.dsl.ApplicationExtension
+import com.android.build.api.dsl.Lint
+import com.android.build.gradle.LibraryExtension
+import org.gradle.api.Plugin
+import org.gradle.api.Project
+import org.gradle.kotlin.dsl.configure
+
+class AndroidLintConventionPlugin : Plugin<Project> {
+ override fun apply(target: Project) {
+ with(target) {
+ when {
+ pluginManager.hasPlugin("com.android.application") ->
+ configure<ApplicationExtension> { lint(Lint::configure) }
+
+ pluginManager.hasPlugin("com.android.library") ->
+ configure<LibraryExtension> { lint(Lint::configure) }
+
+ else -> {
+ pluginManager.apply("com.android.lint")
+ configure<Lint>(Lint::configure)
+ }
+ }
+ }
+ }
+}
+
+private fun Lint.configure() {
+ xmlReport = true
+ sarifReport = true
+}
diff --git a/build-logic/convention/src/main/kotlin/JvmLibraryConventionPlugin.kt b/build-logic/convention/src/main/kotlin/JvmLibraryConventionPlugin.kt
index 4067e289b..35932c835 100644
--- a/build-logic/convention/src/main/kotlin/JvmLibraryConventionPlugin.kt
+++ b/build-logic/convention/src/main/kotlin/JvmLibraryConventionPlugin.kt
@@ -23,6 +23,7 @@ class JvmLibraryConventionPlugin : Plugin<Project> {
with(target) {
with(pluginManager) {
apply("org.jetbrains.kotlin.jvm")
+ apply("nowinandroid.android.lint")
}
configureKotlinJvm()
}
diff --git a/core/designsystem/build.gradle.kts b/core/designsystem/build.gradle.kts
index a40926383..cf9873e2c 100644
--- a/core/designsystem/build.gradle.kts
+++ b/core/designsystem/build.gradle.kts
@@ -23,9 +23,6 @@ android {
defaultConfig {
testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
}
- lint {
- checkDependencies = true
- }
namespace = "com.google.samples.apps.nowinandroid.core.designsystem"
}