Add Bill of Material (#78)

* Fix module versioning in documentation (#76) * Add Bill of Material * Fix build Exclude BOM from adding metalava as it doesn't have api/current.api Co-authored-by: Yacine Rezgui <[email protected]>
google · Jan 19, 2022 · e5fb58a · e5fb58a
1 parent 98b3c1b
commit e5fb58a
Show file tree

Hide file tree

Showing 6 changed files with 39 additions and 2 deletions.
diff --git a/bom/build.gradle.kts b/bom/build.gradle.kts
@@ -0,0 +1,18 @@
+plugins {
+    kotlin("jvm")
+    id("com.vanniktech.maven.publish")
+}
+
+dependencies {
+    constraints {
+        api(project(":permissions"))
+        api(project(":photopicker"))
+        api(project(":storage"))
+        api("com.squareup.okio:okio:3.0.0")
+    }
+}
+
+java {
+    sourceCompatibility = JavaVersion.VERSION_1_8
+    targetCompatibility = JavaVersion.VERSION_1_8
+}
diff --git a/bom/gradle.properties b/bom/gradle.properties
@@ -0,0 +1,3 @@
+POM_ARTIFACT_ID=modernstorage-bom
+POM_NAME=ModernStorage Bill of Material
+POM_PACKAGING=jar
diff --git a/build.gradle b/build.gradle
@@ -70,7 +70,7 @@ subprojects {
         }
     }
 
-    if (project.hasProperty('POM_ARTIFACT_ID')) {
+    if (project.hasProperty('POM_ARTIFACT_ID') && project.properties['POM_ARTIFACT_ID'] != "modernstorage-bom") {
         apply plugin: 'me.tylerbwong.gradle.metalava'
 
         metalava {

diff --git a/docs/README.md b/docs/README.md
@@ -19,6 +19,21 @@ implementation("com.google.modernstorage:modernstorage-permissions:{{ lib_versio
 implementation("com.google.modernstorage:modernstorage-storage:{{ lib_version }}")
 ```
 
+Alternatively use the Bill of Material to just have to define the version once, and then define which modules you need.
+
+```kotlin
+implementation("com.google.modernstorage:modernstorage-bom:{{ lib_version }}")
+
+implementation("com.google.modernstorage:modernstorage-permissions")
+
+implementation("com.google.modernstorage:modernstorage-storage")
+
+// The Bill of Material includes Okio and Photo Picker as well
+implementation("com.google.modernstorage:modernstorage-photopicker")
+
+implementation("com.squareup.okio:okio")
+```
+
 ## Quick start
 
 * Have a look at the [permissions][permissions_guide] and [storage interactions][storage_interactions_guide] guides

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -46,4 +46,4 @@ plugins:
     - macros
 
 extra:
-    lib_version: "1.0.0-alpha04"
+    lib_version: "1.0.0-alpha03"
diff --git a/settings.gradle b/settings.gradle
@@ -15,6 +15,7 @@
  */
 
 rootProject.name = "ModernStorage"
+include ':bom'
 include ':permissions'
 include ':photopicker'
 include ':storage'
-Original file line number
+Diff line change
@@ Expand Up / @@ -46,4 +46,4 @@ plugins: @@
         - macros
     extra:
-        lib_version: "1.0.0-alpha04"
+        lib_version: "1.0.0-alpha03"