Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document SDK deps versions validation feature of Maven plugin #12911

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
+37 −5
Draft

Document SDK deps versions validation feature of Maven plugin #12911

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/platforms/java/common/maven/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,9 @@ We expose the following configuration values, by adding a `<configuration>` sect

<!-- Disable auto-install of SDK and Integrations -->
<skipAutoInstall>false</skipAutoInstall>

<!-- Disable validating consistency of SDK dependency versions -->
<skipValidateSdkDependencyVersions>false</skipValidateSdkDependencyVersions>
</configuration>
<executions>
<execution>
Expand All @@ -71,6 +74,11 @@ We expose the following configuration values, by adding a `<configuration>` sect
<!-- This enables source context, allowing you to see your source -->
<!-- code as part of your stack traces in Sentry. -->
<goal>uploadSourceBundle</goal>

<!-- Validates Sentry SDK dependency versions. -->
<!-- Mixing SDK dependency versions can result in build or run time errors. -->
<!-- If mixed versions are detected, the build will fail. -->
<goal>validateSdkDependencyVersions</goal>
</goals>
</execution>
</executions>
Expand Down
6 changes: 5 additions & 1 deletion platform-includes/getting-started-install/java.log4j2.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<!-- <url>http://localhost:8000/</url> -->
<org>___SENTRY_ORG_SLUG___</org>
<project>___SENTRY_PROJECT_SLUG___</project>
<!-- Do not commit you auth token with this file, you should provide it via the SENTRY_AUTH_TOKEN environment variable or similar -->
<!-- Do not commit your auth token with this file, you should provide it via the SENTRY_AUTH_TOKEN environment variable or similar -->
<!-- <authToken>${env.SENTRY_AUTH_TOKEN}</authToken> -->
<authToken>___SENTRY_AUTH_TOKEN___</authToken>
<!-- Enable debugging to see logs in case something goes wrong when uploading the source bundle -->
Expand All @@ -27,6 +27,10 @@
<!-- This enables source context, allowing you to see your source code as part of your stack traces in Sentry -->
<!-- Learn more about this feature in its dedicated "Source Context" docs page -->
<goal>uploadSourceBundle</goal>
<!-- Validates Sentry SDK dependency versions. -->
<!-- Mixing SDK dependency versions can result in build or run time errors. -->
<!-- If mixed versions are detected, the build will fail. -->
<goal>validateSdkDependencyVersions</goal>
</goals>
</execution>
</executions>
Expand Down
6 changes: 5 additions & 1 deletion platform-includes/getting-started-install/java.logback.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<!-- <url>http://localhost:8000/</url> -->
<org>___SENTRY_ORG_SLUG___</org>
<project>___SENTRY_PROJECT_SLUG___</project>
<!-- Do not commit you auth token with this file, you should provide it via the SENTRY_AUTH_TOKEN environment variable or similar -->
<!-- Do not commit your auth token with this file, you should provide it via the SENTRY_AUTH_TOKEN environment variable or similar -->
<!-- <authToken>${env.SENTRY_AUTH_TOKEN}</authToken> -->
<authToken>___SENTRY_AUTH_TOKEN___</authToken>
<!-- Enable debugging to see logs in case something goes wrong when uploading the source bundle -->
Expand All @@ -27,6 +27,10 @@
<!-- This enables source context, allowing you to see your source code as part of your stack traces in Sentry -->
<!-- Learn more about this feature in its dedicated "Source Context" docs page -->
<goal>uploadSourceBundle</goal>
<!-- Validates Sentry SDK dependency versions. -->
<!-- Mixing SDK dependency versions can result in build or run time errors. -->
<!-- If mixed versions are detected, the build will fail. -->
<goal>validateSdkDependencyVersions</goal>
</goals>
</execution>
</executions>
Expand Down
6 changes: 5 additions & 1 deletion platform-includes/getting-started-install/java.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ plugins {
<!-- <url>http://localhost:8000/</url> -->
<org>___SENTRY_ORG_SLUG___</org>
<project>___SENTRY_PROJECT_SLUG___</project>
<!-- Do not commit you auth token with this file, you should provide it via the SENTRY_AUTH_TOKEN environment variable or similar -->
<!-- Do not commit your auth token with this file, you should provide it via the SENTRY_AUTH_TOKEN environment variable or similar -->
<!-- <authToken>${env.SENTRY_AUTH_TOKEN}</authToken> -->
<authToken>___SENTRY_AUTH_TOKEN___</authToken>
<!-- Enable debugging to see logs in case something goes wrong when uploading the source bundle -->
Expand All @@ -33,6 +33,10 @@ plugins {
<!-- This enables source context, allowing you to see your source code as part of your stack traces in Sentry -->
<!-- Learn more about this feature in its dedicated "Source Context" docs page -->
<goal>uploadSourceBundle</goal>
<!-- Validates Sentry SDK dependency versions. -->
<!-- Mixing SDK dependency versions can result in build or run time errors. -->
<!-- If mixed versions are detected, the build will fail. -->
<goal>validateSdkDependencyVersions</goal>
</goals>
</execution>
</executions>
Expand Down
6 changes: 5 additions & 1 deletion platform-includes/getting-started-install/java.spring-boot.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ plugins {
<!-- <url>http://localhost:8000/</url> -->
<org>___SENTRY_ORG_SLUG___</org>
<project>___SENTRY_PROJECT_SLUG___</project>
<!-- Do not commit you auth token with this file, you should provide it via the SENTRY_AUTH_TOKEN environment variable or similar -->
<!-- Do not commit your auth token with this file, you should provide it via the SENTRY_AUTH_TOKEN environment variable or similar -->
<!-- <authToken>${env.SENTRY_AUTH_TOKEN}</authToken> -->
<authToken>___SENTRY_AUTH_TOKEN___</authToken>
<!-- Enable debugging to see logs in case something goes wrong when uploading the source bundle -->
Expand All @@ -33,6 +33,10 @@ plugins {
<!-- This enables source context, allowing you to see your source code as part of your stack traces in Sentry -->
<!-- Learn more about this feature in its dedicated "Source Context" docs page -->
<goal>uploadSourceBundle</goal>
<!-- Validates Sentry SDK dependency versions. -->
<!-- Mixing SDK dependency versions can result in build or run time errors. -->
<!-- If mixed versions are detected, the build will fail. -->
<goal>validateSdkDependencyVersions</goal>
</goals>
</execution>
</executions>
Expand Down
6 changes: 5 additions & 1 deletion platform-includes/getting-started-install/java.spring.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ plugins {
<!-- <url>http://localhost:8000/</url> -->
<org>___SENTRY_ORG_SLUG___</org>
<project>___SENTRY_PROJECT_SLUG___</project>
<!-- Do not commit you auth token with this file, you should provide it via the SENTRY_AUTH_TOKEN environment variable or similar -->
<!-- Do not commit your auth token with this file, you should provide it via the SENTRY_AUTH_TOKEN environment variable or similar -->
<!-- <authToken>${env.SENTRY_AUTH_TOKEN}</authToken> -->
<authToken>___SENTRY_AUTH_TOKEN___</authToken>
<!-- Enable debugging to see logs in case something goes wrong when uploading the source bundle -->
Expand All @@ -33,6 +33,10 @@ plugins {
<!-- This enables source context, allowing you to see your source code as part of your stack traces in Sentry -->
<!-- Learn more about this feature in its dedicated "Source Context" docs page -->
<goal>uploadSourceBundle</goal>
<!-- Validates Sentry SDK dependency versions. -->
<!-- Mixing SDK dependency versions can result in build or run time errors. -->
<!-- If mixed versions are detected, the build will fail. -->
<goal>validateSdkDependencyVersions</goal>
</goals>
</execution>
</executions>
Expand Down
4 changes: 4 additions & 0 deletions platform-includes/source-context/java.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -296,6 +296,10 @@ Add the Sentry Maven Plugin to your project by adding the following lines to you
<!-- This enables source context, allowing you to see your source -->
<!-- code as part of your stack traces in Sentry. -->
<goal>uploadSourceBundle</goal>
<!-- Validates Sentry SDK dependency versions. -->
<!-- Mixing SDK dependency versions can result in build or run time errors. -->
<!-- If mixed versions are detected, the build will fail. -->
<goal>validateSdkDependencyVersions</goal>
</goals>
</execution>
</executions>
Expand Down