Skip to content

📖 Improve error format in the design docs for API Versioning in Kubebuilder #4693

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

Merged

Conversation

kersten
Copy link
Contributor

@kersten kersten commented Mar 27, 2025

  • Updated fmt.Errorf to use %w for proper error wrapping in code snippets
  • Improves consistency and error traceability in example code

…n.md` design doc

- Updated `fmt.Errorf` to use `%w` for proper error wrapping in code snippets
- Improves consistency and error traceability in example code
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Mar 27, 2025
@k8s-ci-robot
Copy link
Contributor

Hi @kersten. 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 needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Mar 27, 2025
@@ -158,12 +158,12 @@ func (ch *conversionHandler) convertObject(src, dst runtime.Object) error {

err = src.(conversion.Convertible).ConvertTo(hub)
if err != nil {
return fmt.Errorf("%T failed to convert to hub version %T : %v", src, hub, err)
return fmt.Errorf("%T failed to convert to hub version %T : %w", src, hub, err)
Copy link
Member

Choose a reason for hiding this comment

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

See that it has a symble in red.
Can you please check we probably need to fix it?

Copy link
Contributor Author

@kersten kersten Mar 27, 2025

Choose a reason for hiding this comment

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

This is strange, here is my git diff to the master branch:

diff --git a/designs/crd_version_conversion.md b/designs/crd_version_conversion.md
index 8176e024c..728613189 100644
--- a/designs/crd_version_conversion.md
+++ b/designs/crd_version_conversion.md
@@ -158,12 +158,12 @@ func (ch *conversionHandler) convertObject(src, dst runtime.Object) error {
 
     err = src.(conversion.Convertible).ConvertTo(hub)
     if err != nil {
-        return fmt.Errorf("%T failed to convert to hub version %T : %w", src, hub, err)
+        return fmt.Errorf("%T failed to convert to hub version %T : %v", src, hub, err)
     }
 
     err = dst.(conversion.Convertible).ConvertFrom(hub)
     if err != nil {
-        return fmt.Errorf("%T failed to convert from hub version %T : %w", dst, hub, err)
+        return fmt.Errorf("%T failed to convert from hub version %T : %v", dst, hub, err)
     }
     return nil
 }

Copy link
Member

Choose a reason for hiding this comment

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

It is just a design doc as well so I think is all fine .. I am moving forward

@camilamacedo86 camilamacedo86 changed the title 🌱 (chore): wrap conversion errors with %w in crd_version_conversion.md design doc 🌱 (chore): wrap conversion errors with %w in crd_version_conversion.md design doc Mar 27, 2025
Copy link
Member

@camilamacedo86 camilamacedo86 left a comment

Choose a reason for hiding this comment

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

/lgtm
/approve
/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 Mar 27, 2025
@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 27, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: camilamacedo86, kersten

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 Mar 27, 2025
@camilamacedo86 camilamacedo86 changed the title 🌱 (chore): wrap conversion errors with %w in crd_version_conversion.md design doc 📖 L Improve error format in the design docs for API Versioning in Kubebuilder Mar 27, 2025
@camilamacedo86 camilamacedo86 changed the title 📖 L Improve error format in the design docs for API Versioning in Kubebuilder 📖 Improve error format in the design docs for API Versioning in Kubebuilder Mar 27, 2025
@k8s-ci-robot k8s-ci-robot merged commit 1368515 into kubernetes-sigs:master Mar 27, 2025
10 of 11 checks passed
@kersten kersten deleted the chore/crd-version-conversion-doc branch March 27, 2025 18:58
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/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants