From c9b7bb3bdf8bb117e78f70297935fc179c30375a Mon Sep 17 00:00:00 2001 From: Maciej Walkowiak Date: Mon, 5 Jul 2021 10:21:08 +0200 Subject: [PATCH 1/8] Java: Add BOM docs. --- .../getting-started-install-bom/java.mdx | 35 +++++++++++++++++++ src/platforms/common/index.mdx | 2 ++ 2 files changed, 37 insertions(+) create mode 100644 src/includes/getting-started-install-bom/java.mdx diff --git a/src/includes/getting-started-install-bom/java.mdx b/src/includes/getting-started-install-bom/java.mdx new file mode 100644 index 0000000000000..14ddc48c230f0 --- /dev/null +++ b/src/includes/getting-started-install-bom/java.mdx @@ -0,0 +1,35 @@ +### Managing versions for multiple Sentry dependencies + +When multiple Sentry dependencies are used, to avoid specifying the version of each dependency, you can use a *BOM* or *Bill Of Materials*. + +Using Maven you can add the following to `dependencyManagement` section in your `pom.xml`: + +```xml {tabTitle:Maven}{filename:pom.xml} + + + + io.sentry + sentry-bom + {{ packages.version('sentry.java', '5.1.0') }} + pom + import + + + +``` + +and then use dependencies without specifying a version: + +```xml {tabTitle:Maven}{filename:pom.xml} + + io.sentry + sentry + +``` + +Using Gradle 5.0 or higher, you can add the following to the `dependencies` section in your `build.gradle`: + +```groovy {filename:build.gradle} +implementation platform('io.sentry:sentry-bom:{{ packages.version('sentry.java', '5.1.0') }}') //import bom +testImplementation('io.sentry:sentry') //no version specified +``` diff --git a/src/platforms/common/index.mdx b/src/platforms/common/index.mdx index 3e33007727137..3b05196cf3f78 100644 --- a/src/platforms/common/index.mdx +++ b/src/platforms/common/index.mdx @@ -20,6 +20,8 @@ Sentry captures data by using an SDK within your application’s runtime. + + ## Configure From 80804b3548408e714877ed955f1f2b973e9c7eeb Mon Sep 17 00:00:00 2001 From: Maciej Walkowiak Date: Tue, 6 Jul 2021 13:56:49 +0200 Subject: [PATCH 2/8] Move BOM docs to separate section in Java & Android. --- src/platforms/android/common/dependencies.mdx | 45 +++++++++++++++++++ src/platforms/common/index.mdx | 2 - .../java/common/dependencies.mdx} | 16 +++++-- 3 files changed, 58 insertions(+), 5 deletions(-) create mode 100644 src/platforms/android/common/dependencies.mdx rename src/{includes/getting-started-install-bom/java.mdx => platforms/java/common/dependencies.mdx} (71%) diff --git a/src/platforms/android/common/dependencies.mdx b/src/platforms/android/common/dependencies.mdx new file mode 100644 index 0000000000000..9753324d3867e --- /dev/null +++ b/src/platforms/android/common/dependencies.mdx @@ -0,0 +1,45 @@ +--- +title: Managing Dependencies +sidebar_order: 1000 +--- + +## Managing versions for multiple Sentry dependencies + +When multiple Sentry dependencies are used, to avoid specifying the version of each dependency, you can use a *BOM* or *Bill Of Materials*. + +Using Maven you can add the following to `dependencyManagement` section in your `pom.xml`: + +```xml {tabTitle:Maven}{filename:pom.xml} + + + + io.sentry + sentry-bom + {{ packages.version('sentry.java', '5.1.0') }} + pom + import + + + +``` + +and then use dependencies without specifying a version, for example: + +```xml {tabTitle:Maven}{filename:pom.xml} + + io.sentry + sentry-android + + + io.sentry + sentry-android-fragment + +``` + +Using Gradle 5.0 or higher, you can add the following to the `dependencies` section in your `build.gradle`: + +```groovy {filename:build.gradle} +implementation platform('io.sentry:sentry-bom:{{ packages.version('sentry.java', '5.1.0') }}') //import bom +implementation('io.sentry:sentry-android') //no version specified +implementation('io.sentry:sentry-android-fragment') //no version specified +``` diff --git a/src/platforms/common/index.mdx b/src/platforms/common/index.mdx index 3b05196cf3f78..3e33007727137 100644 --- a/src/platforms/common/index.mdx +++ b/src/platforms/common/index.mdx @@ -20,8 +20,6 @@ Sentry captures data by using an SDK within your application’s runtime. - - ## Configure diff --git a/src/includes/getting-started-install-bom/java.mdx b/src/platforms/java/common/dependencies.mdx similarity index 71% rename from src/includes/getting-started-install-bom/java.mdx rename to src/platforms/java/common/dependencies.mdx index 14ddc48c230f0..0170dd4475252 100644 --- a/src/includes/getting-started-install-bom/java.mdx +++ b/src/platforms/java/common/dependencies.mdx @@ -1,4 +1,9 @@ -### Managing versions for multiple Sentry dependencies +--- +title: Managing Dependencies +sidebar_order: 1000 +--- + +## Managing versions for multiple Sentry dependencies When multiple Sentry dependencies are used, to avoid specifying the version of each dependency, you can use a *BOM* or *Bill Of Materials*. @@ -18,18 +23,23 @@ Using Maven you can add the following to `dependencyManagement` section in your ``` -and then use dependencies without specifying a version: +and then use dependencies without specifying a version, for example: ```xml {tabTitle:Maven}{filename:pom.xml} io.sentry sentry + + io.sentry + sentry-logback + ``` Using Gradle 5.0 or higher, you can add the following to the `dependencies` section in your `build.gradle`: ```groovy {filename:build.gradle} implementation platform('io.sentry:sentry-bom:{{ packages.version('sentry.java', '5.1.0') }}') //import bom -testImplementation('io.sentry:sentry') //no version specified +implementation('io.sentry:sentry') //no version specified +implementation('io.sentry:sentry-logback') //no version specified ``` From b50c86554fbe2e7fd2270a579c54fbacbab68cf7 Mon Sep 17 00:00:00 2001 From: Maciej Walkowiak Date: Wed, 14 Jul 2021 13:50:28 +0200 Subject: [PATCH 3/8] Update src/platforms/android/common/dependencies.mdx Co-authored-by: Fiona <61481573+PeloWriter@users.noreply.github.com> --- src/platforms/android/common/dependencies.mdx | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/platforms/android/common/dependencies.mdx b/src/platforms/android/common/dependencies.mdx index 9753324d3867e..4e5467f2fd951 100644 --- a/src/platforms/android/common/dependencies.mdx +++ b/src/platforms/android/common/dependencies.mdx @@ -1,5 +1,6 @@ --- -title: Managing Dependencies +title: Using a BOM +description: "Learn more about using a bill of materials with multiple Sentry dependencies." sidebar_order: 1000 --- From 57c1a1857300d1e73a689bd6a683e9bae563e849 Mon Sep 17 00:00:00 2001 From: Maciej Walkowiak Date: Wed, 14 Jul 2021 13:50:35 +0200 Subject: [PATCH 4/8] Update src/platforms/android/common/dependencies.mdx Co-authored-by: Fiona <61481573+PeloWriter@users.noreply.github.com> --- src/platforms/android/common/dependencies.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/platforms/android/common/dependencies.mdx b/src/platforms/android/common/dependencies.mdx index 4e5467f2fd951..cb29524e42ee8 100644 --- a/src/platforms/android/common/dependencies.mdx +++ b/src/platforms/android/common/dependencies.mdx @@ -6,7 +6,7 @@ sidebar_order: 1000 ## Managing versions for multiple Sentry dependencies -When multiple Sentry dependencies are used, to avoid specifying the version of each dependency, you can use a *BOM* or *Bill Of Materials*. +When you are using multiple Sentry dependencies, you can avoid specifying the version of each dependency with a *BOM* or *Bill Of Materials*. Using Maven you can add the following to `dependencyManagement` section in your `pom.xml`: From 06490c247925e2c7acc6bb903e788af6221616f0 Mon Sep 17 00:00:00 2001 From: Maciej Walkowiak Date: Wed, 14 Jul 2021 13:50:41 +0200 Subject: [PATCH 5/8] Update src/platforms/android/common/dependencies.mdx Co-authored-by: Fiona <61481573+PeloWriter@users.noreply.github.com> --- src/platforms/android/common/dependencies.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/platforms/android/common/dependencies.mdx b/src/platforms/android/common/dependencies.mdx index cb29524e42ee8..1a722fdede8f5 100644 --- a/src/platforms/android/common/dependencies.mdx +++ b/src/platforms/android/common/dependencies.mdx @@ -8,7 +8,7 @@ sidebar_order: 1000 When you are using multiple Sentry dependencies, you can avoid specifying the version of each dependency with a *BOM* or *Bill Of Materials*. -Using Maven you can add the following to `dependencyManagement` section in your `pom.xml`: +Using Maven, add the following to the `dependencyManagement` section in your `pom.xml`: ```xml {tabTitle:Maven}{filename:pom.xml} From bb5ad1231011a64badf89c2ec226afc5f5f53c27 Mon Sep 17 00:00:00 2001 From: Maciej Walkowiak Date: Wed, 14 Jul 2021 13:50:48 +0200 Subject: [PATCH 6/8] Update src/platforms/android/common/dependencies.mdx Co-authored-by: Fiona <61481573+PeloWriter@users.noreply.github.com> --- src/platforms/android/common/dependencies.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/platforms/android/common/dependencies.mdx b/src/platforms/android/common/dependencies.mdx index 1a722fdede8f5..453ef7745766d 100644 --- a/src/platforms/android/common/dependencies.mdx +++ b/src/platforms/android/common/dependencies.mdx @@ -24,7 +24,7 @@ Using Maven, add the following to the `dependencyManagement` section in your `po ``` -and then use dependencies without specifying a version, for example: +Then use dependencies without specifying a version, for example: ```xml {tabTitle:Maven}{filename:pom.xml} From ab7b6be9c01687efdbbd61340378c8aa7780622b Mon Sep 17 00:00:00 2001 From: Maciej Walkowiak Date: Wed, 14 Jul 2021 13:52:45 +0200 Subject: [PATCH 7/8] Polish. --- src/platforms/android/common/dependencies.mdx | 31 ------------------- src/platforms/java/common/dependencies.mdx | 8 ++--- 2 files changed, 3 insertions(+), 36 deletions(-) diff --git a/src/platforms/android/common/dependencies.mdx b/src/platforms/android/common/dependencies.mdx index 453ef7745766d..ddbf3cc6638e9 100644 --- a/src/platforms/android/common/dependencies.mdx +++ b/src/platforms/android/common/dependencies.mdx @@ -4,39 +4,8 @@ description: "Learn more about using a bill of materials with multiple Sentry de sidebar_order: 1000 --- -## Managing versions for multiple Sentry dependencies - When you are using multiple Sentry dependencies, you can avoid specifying the version of each dependency with a *BOM* or *Bill Of Materials*. -Using Maven, add the following to the `dependencyManagement` section in your `pom.xml`: - -```xml {tabTitle:Maven}{filename:pom.xml} - - - - io.sentry - sentry-bom - {{ packages.version('sentry.java', '5.1.0') }} - pom - import - - - -``` - -Then use dependencies without specifying a version, for example: - -```xml {tabTitle:Maven}{filename:pom.xml} - - io.sentry - sentry-android - - - io.sentry - sentry-android-fragment - -``` - Using Gradle 5.0 or higher, you can add the following to the `dependencies` section in your `build.gradle`: ```groovy {filename:build.gradle} diff --git a/src/platforms/java/common/dependencies.mdx b/src/platforms/java/common/dependencies.mdx index 0170dd4475252..a1356d4e16b70 100644 --- a/src/platforms/java/common/dependencies.mdx +++ b/src/platforms/java/common/dependencies.mdx @@ -3,11 +3,9 @@ title: Managing Dependencies sidebar_order: 1000 --- -## Managing versions for multiple Sentry dependencies +When you are using multiple Sentry dependencies, you can avoid specifying the version of each dependency with a *BOM* or *Bill Of Materials*. -When multiple Sentry dependencies are used, to avoid specifying the version of each dependency, you can use a *BOM* or *Bill Of Materials*. - -Using Maven you can add the following to `dependencyManagement` section in your `pom.xml`: +Using Maven, add the following to the `dependencyManagement` section in your `pom.xml`: ```xml {tabTitle:Maven}{filename:pom.xml} @@ -23,7 +21,7 @@ Using Maven you can add the following to `dependencyManagement` section in your ``` -and then use dependencies without specifying a version, for example: +Then use dependencies without specifying a version, for example: ```xml {tabTitle:Maven}{filename:pom.xml} From 835c9ad6406366625bd7de4c9e7a2af2ec6ee1c8 Mon Sep 17 00:00:00 2001 From: Maciej Walkowiak Date: Wed, 14 Jul 2021 14:26:24 +0200 Subject: [PATCH 8/8] BOM pages renamed and moved under "configuration". --- src/includes/getting-started-install/android.mdx | 2 ++ src/includes/getting-started-install/java.jul.mdx | 8 ++++++++ src/includes/getting-started-install/java.log4j2.mdx | 8 ++++++++ src/includes/getting-started-install/java.logback.mdx | 8 ++++++++ src/includes/getting-started-install/java.mdx | 2 ++ src/includes/getting-started-install/java.servlet.mdx | 2 ++ src/includes/getting-started-install/java.spring-boot.mdx | 2 ++ src/includes/getting-started-install/java.spring.mdx | 2 ++ .../bill-of-materials.mdx} | 0 .../bill-of-materials.mdx} | 2 +- 10 files changed, 35 insertions(+), 1 deletion(-) rename src/platforms/android/{common/dependencies.mdx => configuration/bill-of-materials.mdx} (100%) rename src/platforms/java/common/{dependencies.mdx => configuration/bill-of-materials.mdx} (97%) diff --git a/src/includes/getting-started-install/android.mdx b/src/includes/getting-started-install/android.mdx index 6837e66370757..92150817edba4 100644 --- a/src/includes/getting-started-install/android.mdx +++ b/src/includes/getting-started-install/android.mdx @@ -26,4 +26,6 @@ dependencies { Sentry's Android SDK depends on [Gson](https://github.com/google/gson) as a transitive dependency; the minimum required version is 2.7. +If you are using multiple Sentry dependencies, you can add a [bill of materials](/platforms/android/configuration/bill-of-materials) to avoid specifying the version of each dependency. + diff --git a/src/includes/getting-started-install/java.jul.mdx b/src/includes/getting-started-install/java.jul.mdx index 785a8cdf7e703..327ebb539eb01 100644 --- a/src/includes/getting-started-install/java.jul.mdx +++ b/src/includes/getting-started-install/java.jul.mdx @@ -15,3 +15,11 @@ libraryDependencies += "io.sentry" % "sentry-jul" % "{{ packages.version('sentry ``` For other dependency managers, see the [central Maven repository](https://search.maven.org/artifact/io.sentry/sentry-jul). + + + +Sentry's Java SDK depends on [Gson](https://github.com/google/gson) as a transitive dependency; the minimum required version is 2.7. + +If you are using multiple Sentry dependencies, you can add a [bill of materials](/platforms/java/configuration/bill-of-materials) to avoid specifying the version of each dependency. + + diff --git a/src/includes/getting-started-install/java.log4j2.mdx b/src/includes/getting-started-install/java.log4j2.mdx index 6d26450f6f7c8..cd8d82096defc 100644 --- a/src/includes/getting-started-install/java.log4j2.mdx +++ b/src/includes/getting-started-install/java.log4j2.mdx @@ -15,3 +15,11 @@ libraryDependencies += "io.sentry" % "sentry-log4j2" % "{{ packages.version('sen ``` For other dependency managers see the [central Maven repository](https://search.maven.org/artifact/io.sentry/sentry-log4j2). + + + +Sentry's Java SDK depends on [Gson](https://github.com/google/gson) as a transitive dependency; the minimum required version is 2.7. + +If you are using multiple Sentry dependencies, you can add a [bill of materials](/platforms/java/configuration/bill-of-materials) to avoid specifying the version of each dependency. + + diff --git a/src/includes/getting-started-install/java.logback.mdx b/src/includes/getting-started-install/java.logback.mdx index d934521192447..d5b12cd41812c 100644 --- a/src/includes/getting-started-install/java.logback.mdx +++ b/src/includes/getting-started-install/java.logback.mdx @@ -15,3 +15,11 @@ libraryDependencies += "io.sentry" % "sentry-logback" % "{{ packages.version('se ``` For other dependency managers, see the [central Maven repository](https://search.maven.org/artifact/io.sentry/sentry-logback). + + + +Sentry's Java SDK depends on [Gson](https://github.com/google/gson) as a transitive dependency; the minimum required version is 2.7. + +If you are using multiple Sentry dependencies, you can add a [bill of materials](/platforms/java/configuration/bill-of-materials) to avoid specifying the version of each dependency. + + diff --git a/src/includes/getting-started-install/java.mdx b/src/includes/getting-started-install/java.mdx index 7ef6d7dc8daa6..c6b72a4832915 100644 --- a/src/includes/getting-started-install/java.mdx +++ b/src/includes/getting-started-install/java.mdx @@ -26,4 +26,6 @@ libraryDependencies += "io.sentry" % "sentry" % "{{ packages.version('sentry.jav Sentry's Java SDK depends on [Gson](https://github.com/google/gson) as a transitive dependency; the minimum required version is 2.7. +If you are using multiple Sentry dependencies, you can add a [bill of materials](/platforms/java/configuration/bill-of-materials) to avoid specifying the version of each dependency. + diff --git a/src/includes/getting-started-install/java.servlet.mdx b/src/includes/getting-started-install/java.servlet.mdx index 7a28516117590..8a40076c065a5 100644 --- a/src/includes/getting-started-install/java.servlet.mdx +++ b/src/includes/getting-started-install/java.servlet.mdx @@ -22,4 +22,6 @@ For other dependency managers, see the [central Maven repository](https://search Sentry's Java SDK depends on [Gson](https://github.com/google/gson) as a transitive dependency; the minimum required version is 2.7. +If you are using multiple Sentry dependencies, you can add a [bill of materials](/platforms/java/configuration/bill-of-materials) to avoid specifying the version of each dependency. + diff --git a/src/includes/getting-started-install/java.spring-boot.mdx b/src/includes/getting-started-install/java.spring-boot.mdx index 32152b3e91704..d580e8033b92e 100644 --- a/src/includes/getting-started-install/java.spring-boot.mdx +++ b/src/includes/getting-started-install/java.spring-boot.mdx @@ -14,4 +14,6 @@ implementation 'io.sentry:sentry-spring-boot-starter:{{ packages.version('sentry Sentry's Java SDK depends on [Gson](https://github.com/google/gson) as a transitive dependency; the minimum required version is 2.7. +If you are using multiple Sentry dependencies, you can add a [bill of materials](/platforms/java/configuration/bill-of-materials) to avoid specifying the version of each dependency. + diff --git a/src/includes/getting-started-install/java.spring.mdx b/src/includes/getting-started-install/java.spring.mdx index 18ee1001dc858..c255c09423644 100644 --- a/src/includes/getting-started-install/java.spring.mdx +++ b/src/includes/getting-started-install/java.spring.mdx @@ -20,4 +20,6 @@ For other dependency managers see the [central Maven repository](https://search. Sentry's Java SDK depends on [Gson](https://github.com/google/gson) as a transitive dependency; the minimum required version is 2.7. +If you are using multiple Sentry dependencies, you can add a [bill of materials](/platforms/java/configuration/bill-of-materials) to avoid specifying the version of each dependency. + diff --git a/src/platforms/android/common/dependencies.mdx b/src/platforms/android/configuration/bill-of-materials.mdx similarity index 100% rename from src/platforms/android/common/dependencies.mdx rename to src/platforms/android/configuration/bill-of-materials.mdx diff --git a/src/platforms/java/common/dependencies.mdx b/src/platforms/java/common/configuration/bill-of-materials.mdx similarity index 97% rename from src/platforms/java/common/dependencies.mdx rename to src/platforms/java/common/configuration/bill-of-materials.mdx index a1356d4e16b70..bca250ba19d22 100644 --- a/src/platforms/java/common/dependencies.mdx +++ b/src/platforms/java/common/configuration/bill-of-materials.mdx @@ -1,5 +1,5 @@ --- -title: Managing Dependencies +title: Using a BOM sidebar_order: 1000 ---