Skip to content
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.

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

✨ Handle word boundaries and add ellipsis for MaxDescLen #1006

Merged

Conversation

dhaiducek
Copy link
Contributor

Both of the items here are noted in a TODO in the code:

  • Implement word boundary handling
  • Add ellipsis after truncated text that doesn't end in a sentence terminator.
  • (not in TODO) Skips processing if the description is already less than MaxDescLen

Outstanding questions about the initial implementation:

  • Whether the ellipsis should be included in the MaxDescLen--in the implementation I've added it on to the end, so the total length could technically be more than MaxDescLen in some cases.
  • Whether an ellipsis should be present after the sentence terminator (this implementation skips the ellipsis in this case).

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jul 15, 2024
@k8s-ci-robot
Copy link
Contributor

Welcome @dhaiducek!

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
Copy link
Contributor

Hi @dhaiducek. 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 needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Jul 15, 2024
@k8s-ci-robot k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jul 15, 2024
@dhaiducek dhaiducek force-pushed the update-description-handling branch from 97fc093 to 9fca0b1 Compare July 15, 2024 18:14
@sbueringer
Copy link
Member

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jul 18, 2024
Copy link
Member

@alvaroaleman alvaroaleman left a comment

Choose a reason for hiding this comment

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

Thanks for your contribution. Could you please extend pkg/crd/testdata/cronjob_types.go to demonstrate the change in behavior end to end?

@k8s-ci-robot k8s-ci-robot added needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Nov 11, 2024
@dhaiducek dhaiducek force-pushed the update-description-handling branch from 52ef352 to 9fca0b1 Compare November 11, 2024 14:57
@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Nov 11, 2024
@dhaiducek
Copy link
Contributor Author

Sorry for the churn here--inadvertently added a commit message from a different repo. I've reset the commit and will add some integration tests in a subsequent commit. 😬

@dhaiducek dhaiducek force-pushed the update-description-handling branch from 9fca0b1 to 803d779 Compare November 11, 2024 21:51
- Implement word boundary handling
- Add ellipsis

Signed-off-by: Dale Haiducek <[email protected]>
@dhaiducek dhaiducek force-pushed the update-description-handling branch from 803d779 to e42b1a2 Compare November 11, 2024 21:51
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Nov 11, 2024
@dhaiducek
Copy link
Contributor Author

... extend pkg/crd/testdata/cronjob_types.go ...

Hi @alvaroaleman! I've updated the gen_integration_test.go instead. It looked like the cronjob_types.go was for the CRD itself whereas the MaxDescLen is a generation configuration that needed a test at a higher level? If I'm mistaken, let me know!

Copy link
Member

@alvaroaleman alvaroaleman left a comment

Choose a reason for hiding this comment

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

thanks!

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

[APPROVALNOTIFIER] This PR is APPROVED

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

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
Copy link
Contributor

LGTM label has been added.

Git tree hash: 3424804a8454e17ad925ca222b9e72fd45e6a47a

@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 17, 2024
@k8s-ci-robot k8s-ci-robot merged commit ea0b2e5 into kubernetes-sigs:main Nov 17, 2024
8 of 9 checks passed
@dhaiducek dhaiducek deleted the update-description-handling branch November 18, 2024 14:38
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. 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/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants