Update Gradle configuration and GitHub Action workflow (#40)

## Changes made - Update the `code_quality.yml` workflow to use the latest actions versions. - Make Android Lint and Detekt generate SARIF files to be used by the `code_quality.yml` workflow. - Let the `code_quality.yml` workflow run for any PR, even in draft. - Remove unused dependencies from each modules. - Remove unused KAPT Gradle plugin. - Disable unused features in Android Gradle Plugin (`BuildConfig`, res value and shaders generation). ## Notes - No project dependencies have been updated in this PR. - I didn't update the data provider version, as this doesn't need a dedicated release. - If these changes should be merged, the branch protection rule needs to be updated to use the new validation names (`Android Lint`, `Detekt`, and `Unit Test`). --------- Co-authored-by: Joaquim Stähli <[email protected]>
SRGSSR · May 21, 2024 · 62ddb7b · 62ddb7b
1 parent c29b53f
commit 62ddb7b
Show file tree

Hide file tree

Showing 9 changed files with 90 additions and 103 deletions.
diff --git a/.github/workflows/code_quality.yaml b/.github/workflows/code_quality.yaml
@@ -1,75 +1,58 @@
 name: Code quality
+
 on:
   merge_group:
   pull_request:
-    types: [synchronize, opened, reopened, ready_for_review]
 
 jobs:
   android-lint:
-    if: github.event.pull_request.draft == false
+    name: Android Lint
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up JDK 17
-        uses: actions/setup-java@v3
+        uses: actions/setup-java@v4
         with:
           java-version: '17'
           distribution: 'temurin'
-      - uses: reviewdog/action-setup@v1
-      - name: Run android linter
-        uses: gradle/gradle-build-action@v2
-        with:
-          arguments: lint
-      - name: review linter
-        uses: dvdandroid/action-android-lint@master
-        with:
-          github_token: ${{ secrets.RTS_DEVOPS_GITHUB_TOKEN }}
-          lint_xml_file: ./build/reports/android-lint.xml
-          reporter: github-pr-review
-      - name: check linter
-        uses: dvdandroid/action-android-lint@master
-        with:
-          github_token: ${{ secrets.RTS_DEVOPS_GITHUB_TOKEN }}
-          lint_xml_file: ./build/reports/android-lint.xml
-          reporter: github-pr-check
+      - uses: gradle/actions/setup-gradle@v3
+      - name: Run Android Lint
+        run: ./gradlew lint
+      - uses: github/codeql-action/upload-sarif@v3
+        if: success() || failure()
+        with:
+          sarif_file: build/reports/android-lint/
+          category: android-lint
 
   detekt:
-    if: github.event.pull_request.draft == false
+    name: Detekt
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up JDK 17
-        uses: actions/setup-java@v3
+        uses: actions/setup-java@v4
         with:
           java-version: '17'
           distribution: 'temurin'
-      - uses: reviewdog/action-setup@v1
-      - name: review detekt
-        uses: alaegin/[email protected]
-        with:
-          github_token: ${{ secrets.RTS_DEVOPS_GITHUB_TOKEN }}
-          detekt_config: config/detekt.yml
-          reviewdog_reporter: github-pr-review
-          detekt_excludes: "**/build/**,**/.idea/**,**/buildSrc/**,**/androidTest/**,**/test/**,**/resources/**"
-      - name: check detekt
-        uses: alaegin/[email protected]
-        with:
-          github_token: ${{ secrets.RTS_DEVOPS_GITHUB_TOKEN }}
-          detekt_config: config/detekt.yml
-          reviewdog_reporter: github-pr-check
-          detekt_excludes: "**/build/**,**/.idea/**,**/buildSrc/**,**/androidTest/**,**/test/**,**/resources/**"
+      - uses: gradle/actions/setup-gradle@v3
+      - name: Run Detekt
+        run: ./gradlew detekt
+      - uses: github/codeql-action/upload-sarif@v3
+        if: success() || failure()
+        with:
+          sarif_file: build/reports/detekt.sarif
+          category: detekt
 
-  android-unit-test:
-    if: github.event.pull_request.draft == false
+  unit-test:
+    name: Unit Test
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up JDK 17
-        uses: actions/setup-java@v3
+        uses: actions/setup-java@v4
         with:
           java-version: '17'
           distribution: 'temurin'
-      - name: Run android local unit test
-        uses: gradle/gradle-build-action@v2
-        with:
-          arguments: testDebug
+      - uses: gradle/actions/setup-gradle@v3
+      - name: Run Unit Tests
+        run: ./gradlew testDebug
diff --git a/README.md b/README.md
@@ -9,4 +9,3 @@ The library provides:
 * Requests with Retrofit to get the usual metadata associated with SRG SSR productions.
 * Gson serialization and deserialization.
 * A flat object model to easily access the data relevant to front-end users.
-* Dagger2 modules to easy integration.
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -1,15 +1,21 @@
 // Top-level build file where you can add configuration options common to all sub-projects/modules.
 import io.gitlab.arturbosch.detekt.Detekt
+import io.gitlab.arturbosch.detekt.report.ReportMergeTask
 
 plugins {
     alias(libs.plugins.android.application) apply false
     alias(libs.plugins.android.library) apply false
-    alias(libs.plugins.kotlin.kapt) apply false
     alias(libs.plugins.kotlin.android) apply false
     // https://github.com/detekt/detekt
     alias(libs.plugins.detekt)
 }
 
+apply(plugin = "android-reporting")
+
+val detektReportMerge by tasks.registering(ReportMergeTask::class) {
+    output.set(rootProject.layout.buildDirectory.file("reports/detekt.sarif"))
+}
+
 allprojects {
     apply(plugin = "io.gitlab.arturbosch.detekt")
 
@@ -29,14 +35,18 @@ allprojects {
             xml.required.set(false)
             html.required.set(true)
             txt.required.set(false)
-            sarif.required.set(false)
+            sarif.required.set(true)
             md.required.set(false)
         }
+        finalizedBy(detektReportMerge)
     }
 
     dependencies {
-        //noinspection UseTomlInstead
-        detektPlugins("io.gitlab.arturbosch.detekt:detekt-formatting:1.22.0")
+        detektPlugins(libs.detekt.formatting)
+    }
+
+    detektReportMerge {
+        input.from(tasks.withType<Detekt>().map { it.sarifReportFile })
     }
 }
 

diff --git a/data/build.gradle.kts b/data/build.gradle.kts
@@ -2,7 +2,6 @@ plugins {
     alias(libs.plugins.android.library)
     alias(libs.plugins.kotlin.android)
     alias(libs.plugins.kotlin.serialization)
-    alias(libs.plugins.kotlin.kapt)
     `maven-publish`
 }
 
@@ -25,6 +24,12 @@ android {
             proguardFiles(getDefaultProguardFile("proguard-android-optimize.txt"), "proguard-rules.pro")
         }
     }
+
+    buildFeatures {
+        resValues = false
+        shaders = false
+    }
+
     compileOptions {
         sourceCompatibility = JavaVersion.VERSION_1_8
         targetCompatibility = JavaVersion.VERSION_1_8
@@ -35,6 +40,8 @@ android {
     lint {
         // https://developer.android.com/reference/tools/gradle-api/4.1/com/android/build/api/dsl/LintOptions
         abortOnError = false
+        sarifReport = true
+        sarifOutput = rootProject.layout.buildDirectory.file("reports/android-lint/${project.name}.sarif").get().asFile
     }
     publishing {
         singleVariant("release") {
@@ -45,15 +52,11 @@ android {
 }
 
 dependencies {
-    implementation(libs.core.ktx)
     api(libs.kotlinx.serialization.json)
-    detektPlugins(libs.detekt.formatting)
 
     testImplementation(libs.robolectric)
     testImplementation(libs.junit)
-    testImplementation(libs.junit.ktx)
-    androidTestImplementation(libs.ext.junit)
-    androidTestImplementation(libs.espresso.core)
+    testImplementation(libs.ext.junit)
 }
 
 publishing {

diff --git a/dataprovider-paging/build.gradle.kts b/dataprovider-paging/build.gradle.kts
@@ -23,6 +23,12 @@ android {
             proguardFiles(getDefaultProguardFile("proguard-android-optimize.txt"), "proguard-rules.pro")
         }
     }
+
+    buildFeatures {
+        resValues = false
+        shaders = false
+    }
+
     compileOptions {
         sourceCompatibility = JavaVersion.VERSION_1_8
         targetCompatibility = JavaVersion.VERSION_1_8
@@ -33,6 +39,8 @@ android {
     lint {
         // https://developer.android.com/reference/tools/gradle-api/4.1/com/android/build/api/dsl/LintOptions
         abortOnError = false
+        sarifReport = true
+        sarifOutput = rootProject.layout.buildDirectory.file("reports/android-lint/${project.name}.sarif").get().asFile
     }
     publishing {
         singleVariant("release") {
@@ -43,14 +51,8 @@ android {
 }
 
 dependencies {
-    api(project(mapOf("path" to ":dataprovider-retrofit")))
-    implementation(libs.core.ktx)
-    implementation(libs.lifecycle.viewmodel.ktx)
-    api(libs.paging.runtime.ktx)
-
-    testImplementation(libs.junit)
-    androidTestImplementation(libs.ext.junit)
-    androidTestImplementation(libs.espresso.core)
+    api(project(":dataprovider-retrofit"))
+    api(libs.paging.common)
 }
 
 publishing {

diff --git a/dataprovider-retrofit/build.gradle.kts b/dataprovider-retrofit/build.gradle.kts
@@ -23,6 +23,12 @@ android {
             proguardFiles(getDefaultProguardFile("proguard-android-optimize.txt"), "proguard-rules.pro")
         }
     }
+
+    buildFeatures {
+        resValues = false
+        shaders = false
+    }
+
     compileOptions {
         sourceCompatibility = JavaVersion.VERSION_1_8
         targetCompatibility = JavaVersion.VERSION_1_8
@@ -33,6 +39,8 @@ android {
     lint {
         // https://developer.android.com/reference/tools/gradle-api/4.1/com/android/build/api/dsl/LintOptions
         abortOnError = false
+        sarifReport = true
+        sarifOutput = rootProject.layout.buildDirectory.file("reports/android-lint/${project.name}.sarif").get().asFile
     }
     publishing {
         singleVariant("release") {
@@ -43,21 +51,15 @@ android {
 }
 
 dependencies {
-    api(project(mapOf("path" to ":data")))
-    implementation(libs.core.ktx)
-    api(libs.lifecycle.livedata.ktx)
-
-    //retrofit implementation
+    api(project(":data"))
     api(libs.retrofit)
+    compileOnly(libs.androidx.annotation)
     implementation(libs.retrofit2.kotlinx.serialization.converter)
-    //noinspection GradleDependency
     implementation(libs.logging.interceptor)
 
-    testImplementation(libs.junit.ktx)
     testImplementation(libs.junit)
     testRuntimeOnly(libs.robolectric)
-    androidTestImplementation(libs.ext.junit)
-    androidTestImplementation(libs.espresso.core)
+    testImplementation(libs.ext.junit)
 }
 
 publishing {

diff --git a/dataproviderdemo/build.gradle.kts b/dataproviderdemo/build.gradle.kts
@@ -1,7 +1,6 @@
 plugins {
     alias(libs.plugins.android.application)
     alias(libs.plugins.kotlin.android)
-    alias(libs.plugins.kotlin.kapt)
 }
 
 android {
@@ -32,6 +31,11 @@ android {
         }
     }
 
+    buildFeatures {
+        resValues = false
+        shaders = false
+    }
+
     compileOptions {
         sourceCompatibility = JavaVersion.VERSION_1_8
         targetCompatibility = JavaVersion.VERSION_1_8
@@ -45,21 +49,16 @@ android {
         abortOnError = true
         checkAllWarnings = true
         checkDependencies = false
-        xmlReport = true // Enable for Danger Android Lint
-        xmlOutput = file("${project.rootDir}/build/reports/android-lint.xml")
+        sarifReport = true
+        sarifOutput = rootProject.layout.buildDirectory.file("reports/android-lint/${project.name}.sarif").get().asFile
         disable.add("LogConditional")
     }
 }
 
 dependencies {
-    implementation(project(mapOf("path" to ":dataprovider-retrofit")))
-    implementation(project(mapOf("path" to ":dataprovider-paging")))
-    implementation(libs.core.ktx)
+    implementation(project(":dataprovider-retrofit"))
     implementation(libs.appcompat)
     implementation(libs.material)
     implementation(libs.constraintlayout)
-
-    testImplementation(libs.junit)
-    androidTestImplementation(libs.ext.junit)
-    androidTestImplementation(libs.espresso.core)
+    implementation(libs.lifecycle.viewmodel)
 }
diff --git a/gradle.properties b/gradle.properties
@@ -21,5 +21,4 @@ kotlin.code.style=official
 # resources declared in the library itself and none from the library's dependencies,
 # thereby reducing the size of the R class for that library
 android.nonTransitiveRClass=true
-android.defaults.buildfeatures.buildconfig=true
-android.nonFinalResIds=true
+android.nonFinalResIds=true