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

bugfix: resolve non-determinism in deduplicating enum comments #460

Merged
merged 1 commit into from
Feb 27, 2024

Conversation

alexzielenski
Copy link
Contributor

649db69 included a bugfix for duplicated enum values, but did not account for the re-exported enum values not having identical comments. This led to non-deterministic iteration order over the enum types and an output that would change descriptions almost every time you ran it

This PR is a simple fix by applying a deterministic tie breaker (length). If length is equal, then we take the alphabetically lower godoc.

@k8s-ci-robot k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Feb 27, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: alexzielenski

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 approved Indicates a PR has been approved by an approver from all required OWNERS files. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Feb 27, 2024
@alexzielenski alexzielenski changed the title [wip] bugfix: resolve non-determinism in deduplicating enum comments bugfix: resolve non-determinism in deduplicating enum comments Feb 27, 2024
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Feb 27, 2024
@thockin
Copy link
Member

thockin commented Feb 27, 2024

Confirmedt that this fixes my problem, and I no longer see it flipping.

@thockin
Copy link
Member

thockin commented Feb 27, 2024

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 27, 2024
@k8s-ci-robot k8s-ci-robot merged commit 6eff651 into kubernetes:master Feb 27, 2024
4 checks passed
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/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