Skip to content

✨ Add Title marker #1175

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
Apr 14, 2025
Merged

✨ Add Title marker #1175

merged 3 commits into from
Apr 14, 2025

Conversation

matteogastaldello
Copy link
Contributor

This PR adds support for the +kubebuilder:title=<string> marker to the validation package.

The new marker allows users to specify a human-readable title for API resources, which can be used in documentation generation, UI displays, and other contexts where a more descriptive label than the type name is helpful.

This addresses issue #883 "Missing marker for 'title' key" and provides a consistent way to define titles that aligns with other metadata annotations in the controller-tools ecosystem.

@linux-foundation-easycla Linux Foundation: EasyCLA
Copy link

linux-foundation-easycla bot commented Mar 20, 2025 •
edited
Loading

CLA Signed

The committers listed above are authorized under a signed CLA.

@k8s-ci-robot
Copy link
Contributor

Welcome @matteogastaldello!

It looks like this is your first PR to kubernetes-sigs/controller-tools 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/controller-tools has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Mar 20, 2025
@k8s-ci-robot
Copy link
Contributor

Hi @matteogastaldello. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Mar 20, 2025
JoelSpeed
JoelSpeed reviewed Mar 20, 2025
View reviewed changes
Copy link
Contributor

@JoelSpeed JoelSpeed left a comment

Choose a reason for hiding this comment

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

Changes LGTM, but I wondered if there's any way to add some tests for when the validation fails?

@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Mar 20, 2025
@matteogastaldello
Copy link
Contributor Author

Hi @JoelSpeed,
I have added some unit tests for the validation failures. Let me know if further improvements or testing are needed.

JoelSpeed
JoelSpeed reviewed Mar 20, 2025
View reviewed changes
Copy link
Contributor

@JoelSpeed JoelSpeed left a comment

Choose a reason for hiding this comment

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

Lets separate the test cases with different names please, otherwise good

@JoelSpeed
Copy link
Contributor

/ok-to-test
/lgtm

@matteogastaldello Can you sort the CLA out please?

@k8s-ci-robot k8s-ci-robot added the ok-to-test Indicates a non-member PR verified by an org member that is safe to test. label Mar 20, 2025
@k8s-ci-robot k8s-ci-robot added lgtm "Looks good to me", indicates that a PR is ready to be merged. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Mar 20, 2025
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 6da446ec7cfbf9abcbc8217ae8642f0ff7ed9980

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Apr 8, 2025
@matteogastaldello
Copy link
Contributor Author

matteogastaldello commented Apr 8, 2025 •
edited
Loading

Hi @JoelSpeed !
I've sorted out the CLA.
Let me know if any further steps are needed.
Thanks,
Matteo

@JoelSpeed
Copy link
Contributor

CC @alvaroaleman @sbueringer

Would one of you mind doing the approval review please?

@alvaroaleman alvaroaleman added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Apr 8, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: alvaroaleman, matteogastaldello

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 Apr 8, 2025
@matteogastaldello
Copy link
Contributor Author

/retest

@k8s-ci-robot k8s-ci-robot merged commit b836f7a into kubernetes-sigs:main Apr 14, 2025
11 checks passed
dongjiang1989 pushed a commit to dongjiang1989/controller-tools that referenced this pull request May 8, 2025
@matteogastaldello @dongjiang1989
✨ Add Title marker (kubernetes-sigs#1175)
c9c3f3e 
* feat: add title marker

* tests: add validation fail tests

* test: change test name
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@alvaroaleman alvaroaleman alvaroaleman approved these changes

@joelanford joelanford Awaiting requested review from joelanford

@vincepri vincepri Awaiting requested review from vincepri

@JoelSpeed JoelSpeed Awaiting requested review from JoelSpeed

Assignees

@alvaroaleman alvaroaleman

@JoelSpeed JoelSpeed

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. 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. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@matteogastaldello @k8s-ci-robot @JoelSpeed @alvaroaleman