fix: rename version.properties to a unique name to avoid resource collisions - #3628
Conversation
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Advanced Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
🟡 Changes recommended
The public overload removal is breaking, and the resource rename needs migration documentation.
Get a fresh assessment by requesting another Copilot review.
Pull request overview
Renames the SDK version metadata resource to prevent collisions in shaded JARs.
Changes:
- Generates and loads
operator-sdk-version.properties. - Exposes the resource name and adds regression coverage.
- Removes the three-argument
ensureValidoverload.
File summaries
| File | Description |
|---|---|
operator-framework-core/src/test/java/io/javaoperatorsdk/operator/api/config/VersionTest.java |
Verifies resource discovery and commit metadata. |
operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/Utils.java |
Uses the new resource name and removes the overload. |
operator-framework-core/pom.xml |
Updates the generated properties filename. |
Review details
Suppressed comments (1)
operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/Utils.java:45
- This changes a publicly observable resource path, and the PR description explicitly calls out consumers that read or register the file directly. Please add the old-to-new resource-name migration note to the shipped release/migration documentation, including
Utils.VERSION_PROPERTIES_FILE_NAME; otherwise shaded or native-image integrations can silently break on upgrade.
public static final String VERSION_PROPERTIES_FILE_NAME = "operator-sdk-version.properties";
- Files reviewed: 3/3 changed files
- Comments generated: 1
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
2dcef69 to
d1b28b4
Compare
…lisions Signed-off-by: Antonio Fernandez Alhambra <antonio.alhambra@hivemq.com>
d1b28b4 to
c78427d
Compare
|
Thank you @afalhambra-hivemq ! |
Fixes #3627.
Note (for the release notes?): in case of anyone reading
version.propertiesdirectly from the operator-framework-core jar needs to switch to the new file name.PR for the JOSDK webhook repo: operator-framework/josdk-webhooks#415