Android Lint improvements

- Create `LintConventionPlugin` to configure Lint on all compatible modules: Android applications, Android libraries and JVM modules.
- Run `lintProdRelease` in CI instead of the default `lintDemoDebug` which is less important compared to production code.
- Rearrange CI steps to make it more clear that Lint should is an additional step after build (build -> test -> lint).
- Enable SARIF support and upload results to GitHub's CodeQL to get inline feedback on PRs.

If we really need better perfs, we could restore `lint.checkDependencies = true` on the `:app` module and only execute `:app:lintProdRelease`.
But in practice, this does not change the total build time on this project.

.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

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"

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> {

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> {

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
+}

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()
         }

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"
 }