fix: rename version.properties to a unique name to avoid resource collisions by afalhambra-hivemq · Pull Request #3628 · operator-framework/java-operator-sdk · GitHub
Skip to content

fix: rename version.properties to a unique name to avoid resource collisions - #3628

Merged
csviri merged 1 commit into
operator-framework:nextfrom
afalhambra-hivemq:fix/unique-version-properties-resource
Sep 18, 2026
Merged

csviri merged 1 commit into
operator-framework:nextfrom
afalhambra-hivemq:fix/unique-version-properties-resource

Conversation

@afalhambra-hivemq

@afalhambra-hivemq afalhambra-hivemq commented Sep 18, 2026 •

Copy link
Copy Markdown
Contributor

Fixes #3627.

Note (for the release notes?): in case of anyone reading version.properties directly 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

Copilot AI lite review requested due to automatic review settings September 18, 2026 09:01
@coderabbitai

coderabbitai Bot commented Sep 18, 2026 •

Copy link
Copy Markdown

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 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 ensureValid overload.
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.

@afalhambra-hivemq
afalhambra-hivemq force-pushed the fix/unique-version-properties-resource branch from 2dcef69 to d1b28b4 Compare September 18, 2026 09:06
…lisions

Signed-off-by: Antonio Fernandez Alhambra <antonio.alhambra@hivemq.com>

@csviri csviri left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@csviri
csviri merged commit 36b2a92 into operator-framework:next Sep 18, 2026
29 checks passed
@csviri

csviri commented Sep 18, 2026

Copy link
Copy Markdown
Collaborator

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants