Add automated dependency license documentation (#7)

Author: afarber

.github/workflows/_docs.yml

@@ -39,6 +39,14 @@ jobs:
       - name: Build documentation
         run: ./gradlew dokkaGenerate --no-daemon
 
+      - name: Generate License Report
+        run: ./gradlew generateLicenseReport --no-daemon
+
+      - name: Copy License Report to Docs
+        run: |
+          mkdir -p openmapview/build/dokka/html/licenses
+          cp openmapview/build/reports/licenses/licenses.html openmapview/build/dokka/html/licenses/index.html
+
       - name: Upload documentation artifact
         uses: actions/upload-artifact@v4
         with:

README.md

@@ -20,6 +20,22 @@ dependencies {
 
 The library is available on [Maven Central](https://central.sonatype.com/artifact/de.afarber/openmapview). Alternative distribution via [JitPack](https://jitpack.io/#afarber/OpenMapView) is also supported.
 
+## License Compliance
+
+OpenMapView is licensed under the **MIT License** - use freely in commercial apps.
+
+**Dependency Licenses:**
+- All runtime dependencies use Apache 2.0 or MIT licenses (business-friendly)
+- View complete [Dependency License Report](https://afarber.github.io/OpenMapView/licenses/)
+- No GPL or restrictive copyleft licenses
+
+**Dependencies (5 total):**
+- androidx.core:core-ktx (Apache 2.0)
+- androidx.lifecycle:lifecycle-runtime-ktx (Apache 2.0)
+- androidx.compose.ui:ui-graphics (Apache 2.0)
+- io.ktor:ktor-client-android (Apache 2.0)
+- com.jakewharton:disklrucache (Apache 2.0)
+
 ## Features
 
 - Drop-in compatible with Google `MapView` (non-deprecated methods only)

docs/CONTRIBUTING.md

@@ -51,6 +51,38 @@ Running `./gradlew spotlessApply` automatically adds this header to any files mi
 
 The CI pipeline includes a copyright check that will fail if any `.kt` files are missing the required header.
 
+### 3. Dependency Management
+
+Before adding new dependencies to OpenMapView, verify the following:
+
+1. **License Compatibility**: Only add dependencies with permissive licenses
+   - Preferred: Apache 2.0, MIT, BSD
+   - Prohibited: GPL, AGPL (would affect library users)
+   - Consult before adding: LGPL, EPL, MPL
+
+2. **Verify License**: Run the license report to check all dependencies
+   ```bash
+   ./gradlew generateLicenseReport
+   ```
+   View the report at: `openmapview/build/reports/licenses/licenses.html`
+
+3. **Minimal Footprint**: Keep dependencies minimal
+   - OpenMapView currently has only 5 runtime dependencies
+   - New dependencies must provide essential functionality
+   - Avoid bloat - see [ARCHITECTURE.md](ARCHITECTURE.md) for philosophy
+
+4. **Auto-Publishing**: License reports automatically publish to the documentation site
+   - URL: https://afarber.github.io/OpenMapView/licenses/
+   - Updated on every docs deployment
+   - No manual maintenance needed
+
+**Current Dependencies** (all Apache 2.0 or MIT):
+- androidx.core:core-ktx
+- androidx.lifecycle:lifecycle-runtime-ktx
+- androidx.compose.ui:ui-graphics
+- io.ktor:ktor-client-android
+- com.jakewharton:disklrucache
+
 ## Automated Git Hooks (Recommended)
 
 Git hooks can automatically check formatting and copyright headers before commits, preventing CI failures.

gradle/libs.versions.toml

@@ -35,6 +35,7 @@ kotlinx-coroutines = "1.10.2"
 
 # Code Quality
 ktlint = "1.3.1"
+license-report = "2.9"
 
 [libraries]
 # AndroidX Core
@@ -78,6 +79,7 @@ kotlin-compose = { id = "org.jetbrains.kotlin.plugin.compose", version.ref = "ko
 spotless = { id = "com.diffplug.spotless", version.ref = "spotless" }
 dokka = { id = "org.jetbrains.dokka", version.ref = "dokka" }
 nmcp = { id = "com.gradleup.nmcp.aggregation", version.ref = "nmcp" }
+license-report = { id = "com.github.jk1.dependency-license-report", version.ref = "license-report" }
 
 [bundles]
 # Common dependencies for example apps

openmapview/build.gradle.kts

@@ -3,6 +3,7 @@ plugins {
     alias(libs.plugins.kotlin.android)
     alias(libs.plugins.spotless)
     alias(libs.plugins.dokka)
+    alias(libs.plugins.license.report)
     id("maven-publish")
     id("signing")
     id("jacoco")
@@ -231,6 +232,21 @@ signing {
     sign(publishing.publications)
 }
 
+licenseReport {
+    // Include only runtime dependencies (exclude test deps)
+    configurations = arrayOf("releaseRuntimeClasspath")
+
+    // Generate HTML report
+    renderers =
+        arrayOf(
+            com.github.jk1.license.render
+                .InventoryHtmlReportRenderer("licenses.html", "Dependency Licenses"),
+        )
+
+    // Output directory
+    outputDir = "${layout.buildDirectory.get()}/reports/licenses"
+}
+
 dokka {
     moduleName.set("OpenMapView")
     moduleVersion.set(rootProject.ext["libVersion"] as String)