🔨 Build: verify on check that all dependencies have compatible licenses

.github/workflows/ci.yml

@@ -4,7 +4,7 @@ on: push
 
 jobs:
   Build:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
 
     steps:
       - name: Set up JDK 11
@@ -14,12 +14,12 @@ jobs:
 
       - uses: actions/checkout@v2
 
-      - name: Lint and test
-        run: ./gradlew ktlintCheck ktlintTestSourceSetCheck ktlintAndroidTestSourceSetCheck lintDebug testDebugUnitTest --stacktrace
+      - name: Lint and check
+        run: ./gradlew check ktlintCheck ktlintTestSourceSetCheck ktlintAndroidTestSourceSetCheck lintDebug testDebugUnitTest --stacktrace
 
-      - name: Publish test reports
+      - name: Publish reports
         uses: actions/upload-artifact@v1
         with:
-          name: test-reports
+          name: reports
           path: sample-learning-app/build/reports
         if: ${{ failure() }}

sample-learning-app/allowed-licenses.json

@@ -0,0 +1,24 @@
+{
+  "allowedLicenses": [
+    { "moduleLicense": "MIT" },
+    { "moduleLicense": "MIT License" },
+    { "moduleLicense": "The MIT License" },
+
+    { "moduleLicense": "BSD-2-Clause" },
+    { "moduleLicense": "BSD 2-Clause" },
+    { "moduleLicense": "The BSD 2-Clause License" },
+
+    { "moduleLicense": "BSD-3-Clause" },
+    { "moduleLicense": "BSD 3-Clause" },
+    { "moduleLicense": "The BSD 3-Clause License" },
+
+    { "moduleLicense": "Apache-2.0" },
+    { "moduleLicense": "Apache 2.0" },
+    { "moduleLicense": "The Apache Software License, Version 2.0" },
+    { "moduleLicense": "The Apache License, Version 2.0" },
+    { "moduleLicense": "Apache License, Version 2.0" },
+
+    { "moduleLicense": "Zlib" },
+    { "moduleLicense": "zlib License" }
+  ]
+}

sample-learning-app/build.gradle.kts

@@ -7,6 +7,7 @@ plugins {
     id("org.jetbrains.kotlin.kapt")
     id("dagger.hilt.android.plugin")
     id("org.jlleitschuh.gradle.ktlint") version Versions.ktlintGradle
+    id("com.github.jk1.dependency-license-report") version "2.8"
 }
 
 val version = getAppVersion()
@@ -74,6 +75,21 @@ android {
     }
 }
 
+licenseReport {
+    configurations = arrayOf("releaseRuntimeClasspath")
+    allowedLicensesFile = File("$projectDir/allowed-licenses.json")
+}
+
+tasks.named("checkLicense") {
+    // The checkLicense task does not declare this input itself, so we do it here. This ensures
+    // that a modification of the file causes the checkLicense task to be re-evaluated.
+    inputs.file("$projectDir/allowed-licenses.json")
+}
+
+tasks.named("check") {
+    dependsOn("checkLicense")
+}
+
 dependencies {
     implementation("androidx.core:core-ktx:1.8.0")
     implementation("androidx.appcompat:appcompat:1.4.2")