bvolpato commented on code in PR #29513: URL: https://github.com/apache/beam/pull/29513#discussion_r1401403653
########## website/www/site/content/en/documentation/sdks/java-dependencies.md: ########## @@ -18,29 +18,52 @@ limitations under the License. # Beam SDK for Java dependencies -The Beam SDKs depend on common third-party components which then -import additional dependencies. Version collisions can result in unexpected -behavior in the service. If you are using any of these packages in your code, be -aware that some libraries are not forward-compatible and you may need to pin to -the listed versions that will be in scope during execution. +The Apache Beam SDKs depend on common third-party components. These components +import additional dependencies. You need to manage your dependencies for the following reasons: -Compile and runtime dependencies for your Beam SDK version are listed in `BeamModulePlugin.groovy` in the Beam repository. To view them, perform the following steps: +- Dependencies might have version collisions or incompatible classes and libraries. +- Some libraries are not forward compatible. When you use these packages in your code, + you might need to pin to the appropriate versions so that those version are used + when you run your pipeline. -1. Open `BeamModulePlugin.groovy`. +When problems occur with dependencies, you might see unexpected behavior in the service, +including errors such as `NoClassDefFoundError`, `NoSuchMethodError`, `NoSuchFieldError`, +or `FATAL ERROR in native method`. + +This page explains how to view the dependencies that your SDK is using and how to manage your +dependencies to avoid issues. + +## View dependencies + +To view your dependencies, either use the Review Comment: linter: trailing space ########## website/www/site/content/en/documentation/sdks/java-dependencies.md: ########## @@ -18,29 +18,52 @@ limitations under the License. # Beam SDK for Java dependencies -The Beam SDKs depend on common third-party components which then -import additional dependencies. Version collisions can result in unexpected -behavior in the service. If you are using any of these packages in your code, be -aware that some libraries are not forward-compatible and you may need to pin to -the listed versions that will be in scope during execution. +The Apache Beam SDKs depend on common third-party components. These components +import additional dependencies. You need to manage your dependencies for the following reasons: -Compile and runtime dependencies for your Beam SDK version are listed in `BeamModulePlugin.groovy` in the Beam repository. To view them, perform the following steps: +- Dependencies might have version collisions or incompatible classes and libraries. +- Some libraries are not forward compatible. When you use these packages in your code, + you might need to pin to the appropriate versions so that those version are used + when you run your pipeline. -1. Open `BeamModulePlugin.groovy`. +When problems occur with dependencies, you might see unexpected behavior in the service, +including errors such as `NoClassDefFoundError`, `NoSuchMethodError`, `NoSuchFieldError`, +or `FATAL ERROR in native method`. + +This page explains how to view the dependencies that your SDK is using and how to manage your +dependencies to avoid issues. + +## View dependencies + +To view your dependencies, either use the +`BeamModulePlugin.groovy` file or retrieve the list by creating a new project +through Maven and resolving the dependencies. + +### Use BeamModulePlugin.groovy to retrieve dependencies + +The `BeamModulePlugin.groovy` file in the Beam repository lists compile and runtime +dependencies for your Beam SDK version. Review Comment: linter: trailing space -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
