Skip to content

Add Maven dependency management documentation#155

Open
ivanauth wants to merge 2 commits into
authzed:mainfrom
ivanauth:docs/maven-best-practices
Open

Add Maven dependency management documentation#155
ivanauth wants to merge 2 commits into
authzed:mainfrom
ivanauth:docs/maven-best-practices

Conversation

@ivanauth

@ivanauth ivanauth commented Oct 31, 2025

Copy link
Copy Markdown
Contributor

This PR adds documentation to help Maven users resolve dependency convergence issues when using authzed-java with the maven-enforcer-plugin.

What's included

README.md

  • New section on Maven dependency convergence with a practical example using the gRPC BOM
  • Updated installation examples to reference the current versions (1.5.4 and gRPC 1.75.0)

MAVEN_BEST_PRACTICES.md (new file)

  • Comprehensive guide explaining dependency convergence and why it matters
  • Three approaches ranked by preference: gRPC BOM (recommended), explicit version pinning, and exclusions
  • Complete working example with enforcer plugin configuration
  • Troubleshooting section for common issues
  • Links to official Maven and gRPC documentation

Why this matters

After the dependency convergence fixes in #152 and #153, users may still encounter convergence errors depending on their Maven setup. This documentation provides clear guidance on how to configure projects correctly.
@ivanauth ivanauth requested a review from a team as a code owner October 31, 2025 15:23
@ivanauth ivanauth force-pushed the docs/maven-best-practices branch from 19a4260 to 9d0041e Compare January 20, 2026 18:22
@ivanauth ivanauth force-pushed the docs/maven-best-practices branch from 9d0041e to a66963f Compare June 23, 2026 19:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

1 participant

@ivanauth