operator-framework / operator-framework/java-operator-sdk
Colliding root-level version.properties can misreport the SDK version
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Java
- Sterne
- 944
- Forks
- 242
- Ø Merge
- 1 T. 4 Std.
- Gemergte PRs (30 T.)
- 43
Beschreibung
Bug Report
What did you do?
Built an operator as a single shaded jar depending on both io.javaoperatorsdk:operator-framework-core (5.6.1) and io.javaoperatorsdk:kubernetes-webhooks-framework-core (3.0.4). Both artifacts generate a root-level version.properties via the git-commit-id-maven-plugin, so the two files collide at the same jar entry path.
What did you expect to see?
The operator startup log reports operator-framework-core's commit id and build time, which Utils.loadFromProperties() reads from version.properties.
What did you see instead? Under which circumstances?
ClassLoader.getResourceAsStream returns the first match, so Utils can silently report the webhooks framework's commit id and build time as the SDK version. This only surfaces when the jars are merged into one (or the classpath puts the webhooks jar first), which is probably why it went unnoticed: setups that keep the jars separate, such as Quarkus, usually resolve the operator-framework-core copy first.
Possible Solution
Give each artifact a uniquely named properties file:
- operator-framework-core:
operator-sdk-version.properties, updating the lookup inUtils.loadFromProperties()(its only reader) - kubernetes-webhooks-framework-core: for example
kubernetes-webhooks-framework-version.properties(nothing reads it today, so it is only a rename); I can file a companion issue there
Happy to contribute PRs (for both repos if needed).
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginnen Sie damit, Utils.loadFromProperties() und die Konfiguration von git-commit-id-maven-plugin zu finden, die version.properties erstellt. Benennen Sie die Ressource von operator-framework-core um und aktualisieren Sie deren Suche. Erstellen Sie anschließend ein shaded jar, das beide Framework-Artefakte enthält, und überprüfen Sie, dass das Startprotokoll die Commit-ID und die Build-Zeit des Operator-Frameworks ausgibt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- java, kubernetes
- Bereich
- build-system
- Issue-Typ
- Bug
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Aktiv
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 72/100