Skip to content

stop exporting jsoniter based apis #288

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
merged 2 commits into from
Apr 18, 2025

Conversation

BenTheElder
Copy link
Member

see: #202

TODO: should we bump the module to v6 since this removes APIs?

I can't find evidence that anyone else was using these:

none in the org:
https://cs.k8s.io/?q=(ReadJSONIter)%7C(WriteJSONStream)&i=nope&literal=nope&files=&excludeFiles=vendor&repos=

only in vendor/:
https://grep.app/search?f.lang=Go&regexp=true&q=%28ReadJSONIter%29%7C%28WriteJSONStream%29

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Apr 18, 2025
@k8s-ci-robot k8s-ci-robot requested review from Jefftree and yliaog April 18, 2025 19:10
@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Apr 18, 2025
@BenTheElder
Copy link
Member Author

TODO: should we bump the module to v6 since this removes APIs?

Yes, because apidiff fails :-)

NOTE: v5 was used in a previous release attempt, so we skip to v6
@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 Apr 18, 2025
@k8s-ci-robot
Copy link
Contributor

@BenTheElder: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
pull-structured-merge-diff-apidiff 046e0a3 link false /test pull-structured-merge-diff-apidiff

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

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. I understand the commands that are listed here.

@BenTheElder
Copy link
Member Author

NOTE: apidiff now fails because the module version was bumped.
https://prow.k8s.io/view/gs/kubernetes-ci-logs/pr-logs/pull/kubernetes-sigs_structured-merge-diff/288/pull-structured-merge-diff-apidiff/1913310145010470912

I could see an argument for either way.

/assign @jpbetz

@jpbetz
Copy link
Contributor

jpbetz commented Apr 18, 2025

/approve
/lgtm
I agree this worth bumping major version for.

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

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: BenTheElder, jpbetz

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 18, 2025
@k8s-ci-robot k8s-ci-robot merged commit f12ecbb into kubernetes-sigs:master Apr 18, 2025
5 of 6 checks passed
@BenTheElder BenTheElder deleted the unexport-jsoniter branch April 18, 2025 19:26
@liggitt
Copy link
Contributor

liggitt commented Apr 18, 2025

let's wait to tag a v6 release until we're sure we've made all the public API changes we need?

edit: ha... too late... no big deal, numbers are cheap if we need a v7

@BenTheElder
Copy link
Member Author

let's wait to tag a v6 release until we're sure we've made all the public API changes we need?

These are the only places that directly reference jsoniter in the public API.
I think it makes sense to proactively drop this (and mark it) to prevent any adoption from consumers.

For actually switching libraries, it's possible we could need changes elsewhere due to not having a clear path to implement with another library, but I think that'd be a last resort and seems unlikely...?

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

4 participants