Centrally Manage Dependency Versions for google-auth-library and the rest of the libraries in google-cloud-java

Offen
  • Stimmt etwas nicht?
#13,176 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Anfängerfreundlichkeit
25/100
Issue-Typ
Refactoring
Klarheit
Muss geklärt werden
Aktivitätsstatus
Ruhig
Tech-Stack
java
Bereich
build-system, release

Rechercherichtung

Vergleiche die Abhängigkeitseigenschaften in google-auth-library-java/pom.xml mit denen in sdk-platform-java/gapic-generator-java-pom-parent/pom.xml und prüfe anschließend die drei vorgeschlagenen Ansätze. Vor der Implementierung ist eine Entscheidung eines Maintainers erforderlich; „done“ sollte bedeuten, dass gemeinsame Abhängigkeitsversionen konsistent verwaltet werden, ohne eine zirkuläre Maven Central-Staging-Abhängigkeit zu erzeugen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

priority: p1 type: feature request

The Problem: Auth Dependencies Are Managed Separately

Currently, the google-auth-library-java module manages its third-party dependencies (like Guava, Protobuf, Jackson, and JUnit) separately within its own local <properties> block. The rest of the monorepo manages identical dependencies inside gapic-generator-java-pom-parent.

This duplicates versions and increases the risk of dependency drift across the monorepo:

  • google-auth-library-java/pom.xml
  • sdk-platform-java/gapic-generator-java-pom-parent/pom.xml

Because com.google.auth and com.google.cloud deploy under different staging profiles on Maven Central, they are uploaded to separate staging repositories. If google-auth-library-java references unreleased in-development versions of com.google.cloud parent POMs or BOMs, a circular release staging deadlock is created at release time.

Proposed Solutions

Option 1: Extract Version Properties to google-cloud-shared-config

Move shared version properties (like <guava.version>) into the external parent POM com.google.cloud:google-cloud-shared-config from which both modules inherit.

  • Pros:
    • Single, definitive source of truth at the parent configuration level.
    • Completely clean code structure with zero duplicate config.
  • Cons:
    • Rigid Release Pipeline: Upgrading a dependency (like an urgent security CVE patch) requires releasing a new version of google-cloud-shared-config to Maven Central first, waiting for Central's CDN to sync, and then updating the parent references in both projects.
Option 2: Extract Versions to a Common Base BOM Module (in Monorepo)

Introduce a lightweight, internal BOM module (e.g., base-shared-dependencies) in this monorepo containing only the third-party library versions. Both the auth library and client library BOMs would import it.

  • Pros:
    • Prevents circular staging deadlocks by maintaining a strictly acyclic dependency graph.
    • Single source of truth located directly within the same monorepo.
  • Cons:
    • Release Staging Delay: Due to staging profile boundaries, releases must be built sequentially (waiting for the base BOM to fully sync to Maven Central before releasing the auth library, and then repeating before client libraries can release).
Option 3: Keep It as It Is and Use Automation to Update

Keep the properties blocks isolated inside their respective directories, but coordinate updates strictly using Renovate Bot or other CI scripting to bump them in parallel.

  • Pros:
    • Maximum Autonomy: The auth team can delay upgrades to preserve legacy client compatibility (like Firebase/Android) without blocking the client libraries.
    • Zero Release Bottlenecks: No sequential staging wait-times; both projects release in parallel.
  • Cons:
    • Relies on external tooling and automation scripts to maintain consistency; human error/drift is still possible if manually edited.
Vorherrschende Sprache
Java
Sterne
2.1k
Forks
1.2k
Ø Merge
2 T. 14 Std.
Gemergte PRs (30 T.)
192

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus googleapis/google-cloud-java

Alle Issues in googleapis/google-cloud-java

Ähnliche Issues

Weitere Issues zu Java

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.