Skip to content

Conversation

@richardcase
Copy link
Member

@richardcase richardcase commented Jul 25, 2025

What this PR does / why we need it:

This adds a new cli utility which given a version number will check that there is a release series defined in a metadata file for that version.

The main use case for this is a CI check. When building a release of a provider that is for a new major or minor version, it's required that a new release series is added to the providers' metadata file. This ensures that the correct version of the provider is installed when initializing a management cluster.

A common failure for release pipelines is that the metadata file hasn't been updated and it's only found out when someone tries to deploy the new version.

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #

/area util

@k8s-ci-robot k8s-ci-robot added area/clusterctl Issues or PRs related to clusterctl cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Jul 25, 2025
@k8s-ci-robot k8s-ci-robot requested review from Jont828 and sivchari July 25, 2025 14:12
@k8s-ci-robot k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jul 25, 2025
@richardcase richardcase force-pushed the metadata_file_checker branch from 846c0e4 to 12b25d6 Compare July 25, 2025 14:15
@fabriziopandini
Copy link
Member

have you consider to add this to hack tools like we have for other tools we are using in CI or during release?

@richardcase
Copy link
Member Author

have you consider to add this to hack tools like we have for other tools we are using in CI or during release?

I hadn't to be honest. I thought it would be mostly used by providers and may be easier from clusterctl. But thinking about it a single responsibility cli tool in hack/tools may be better and providers can go install in their release pipelines. I will change it, thanks @fabriziopandini .

Moving to WIP whilst i make the change.

@richardcase richardcase changed the title 🌱 feat: add check metadata command to clusterctl WIP: 🌱 feat: add check metadata command to clusterctl Jul 25, 2025
@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 25, 2025
@fabriziopandini
Copy link
Member

Thanks,
I think we should keep clusterctl scope limited and user focused (dev tools should go in hack tools)

@richardcase richardcase force-pushed the metadata_file_checker branch from 12b25d6 to 54ea9cc Compare July 29, 2025 10:49
@richardcase richardcase changed the title WIP: 🌱 feat: add check metadata command to clusterctl 🌱 feat: add check metadata command to clusterctl Jul 29, 2025
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 29, 2025
@richardcase richardcase force-pushed the metadata_file_checker branch from 54ea9cc to 3dbd25b Compare July 29, 2025 13:24
@richardcase
Copy link
Member Author

/remove-area clusterctl
/area util

@k8s-ci-robot k8s-ci-robot added area/util Issues or PRs related to utils and removed area/clusterctl Issues or PRs related to clusterctl labels Jul 29, 2025
@richardcase richardcase changed the title 🌱 feat: add check metadata command to clusterctl 🌱 feat: add check version against metadata utility Jul 29, 2025
@richardcase
Copy link
Member Author

Changed so this is now in hack/tools like other CLI helper tools.

@sbueringer
Copy link
Member

What is the latest state of this PR?

@richardcase richardcase force-pushed the metadata_file_checker branch from 3dbd25b to a6c8dcf Compare November 10, 2025 16:11
@richardcase
Copy link
Member Author

What is the latest state of this PR?

I made the suggested change (finally). I think this is good to go.

@sbueringer
Copy link
Member

Happy to approve/merge once the last 2 nits are addressed

@richardcase richardcase force-pushed the metadata_file_checker branch from a6c8dcf to 940fa3f Compare November 12, 2025 15:32
This adds a CLI utility which given a version number will
check that there is a release series defined in a metadata file for
that version.

The main use case for this is a CI check. When building a release of a
provider that is for a new major or minor version its required that a
new release series is added to the providers metadata file. This ensures
that the correct version of the provider is installed when initializing
a management cluster.

A common failure for release pipelines is that the metadata file hasn't
been updated.

Signed-off-by: Richard Case <[email protected]>
@richardcase richardcase force-pushed the metadata_file_checker branch from 940fa3f to d35872e Compare November 12, 2025 15:33
@sbueringer
Copy link
Member

Thank you!

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 12, 2025
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 5d09505168092a9e5ec08f3102e6887e65dfbb53

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sbueringer

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 12, 2025
@k8s-ci-robot k8s-ci-robot merged commit 171e0ae into kubernetes-sigs:main Nov 12, 2025
25 checks passed
@k8s-ci-robot k8s-ci-robot added this to the v1.12 milestone Nov 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. area/util Issues or PRs related to utils cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants