controller-tools icon indicating copy to clipboard operation
controller-tools copied to clipboard

:sparkles: Handle word boundaries and add ellipsis for `MaxDescLen`

Open dhaiducek opened this issue 1 year ago • 4 comments

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).

dhaiducek avatar Jul 15 '24 16:07 dhaiducek

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. :smiley:

k8s-ci-robot avatar Jul 15 '24 16:07 k8s-ci-robot

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 avatar Jul 15 '24 16:07 k8s-ci-robot

/ok-to-test

sbueringer avatar Jul 18 '24 06:07 sbueringer

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 avatar Nov 11 '24 14:11 dhaiducek

... 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!

dhaiducek avatar Nov 11 '24 21:11 dhaiducek

[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 avatar Nov 17 '24 18:11 k8s-ci-robot

LGTM label has been added.

Git tree hash: 3424804a8454e17ad925ca222b9e72fd45e6a47a

k8s-ci-robot avatar Nov 17 '24 18:11 k8s-ci-robot