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.

Sign up for GitHub

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

Jump to bottom

Non functional improvements #65

Merged
merged 5 commits into from
Nov 2, 2021
Merged

Non functional improvements #65

merged 5 commits into from
Nov 2, 2021

Conversation

inteon
Copy link
Member

@inteon inteon commented Oct 26, 2021

extracted all non-functional improvements from #61

  • longer more descriptive variable names
  • easier to write tests
  • removed vendor folder (use go modules instead)
  • updated github workflows

@inteon
remove vendor folder
740b971 
Signed-off-by: Inteon <42113979+inteon@users.noreply.github.com>
@inteon
add 1.16 and 1.17 to github workflows
59dc8b4 
Signed-off-by: Inteon <42113979+inteon@users.noreply.github.com>
@inteon
expand variable names in fields.go
4924d91 
Signed-off-by: Inteon <42113979+inteon@users.noreply.github.com>
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Oct 26, 2021
@k8s-ci-robot k8s-ci-robot added sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Oct 26, 2021
@inteon inteon mentioned this pull request Oct 26, 2021
Closed
luxas
luxas reviewed Oct 28, 2021
View reviewed changes
Copy link

@luxas luxas left a comment

Choose a reason for hiding this comment

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

Thanks a lot for this @inteon, amazing work 🎉 💯!!

I added some more context to the comments, such that it is clear in the "contract" what is happening. These comments can guide in writing more unit tests to capture how things are working today. Then, in v2, we might want to change some of the functionality, and then it is very clear what is changing when we can modify the same unit test output meanwhile.

unmarshal.go Outdated Show resolved Hide resolved
unmarshal.go Outdated Show resolved Hide resolved
unmarshal.go Outdated Show resolved Hide resolved
marshal.go Outdated Show resolved Hide resolved
marshal.go Outdated Show resolved Hide resolved
yaml_test.go Show resolved Hide resolved
yaml_test.go Outdated Show resolved Hide resolved
yaml_test.go Show resolved Hide resolved
yaml_test.go Outdated Show resolved Hide resolved
yaml_test.go Show resolved Hide resolved
@k8s-ci-robot k8s-ci-robot added the do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. label Oct 29, 2021
@inteon
Copy link
Member Author

inteon commented Oct 29, 2021

@luxas thanks for the review; I updated as suggested and also added a ton of extra testcases
some of these tests uncovered some exotic behavior (values of fields with key "a" and "A" get merged depending on the order in which they were defined)

@liggitt I think this PR is ready to get merged.

@inteon inteon force-pushed the non_functional branch 2 times, most recently from ad85ea1 to 46e3f76 Compare October 29, 2021 13:16
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. label Oct 29, 2021
@inteon inteon requested a review from luxas October 29, 2021 14:41
@inteon
expand variable names in yaml.go, add better comments, improve errors…
3c98e65 
…, add copyright

Signed-off-by: Inteon <42113979+inteon@users.noreply.github.com>
@inteon
greatly improve testing framework & added a lot of new tests
4f103b1 
Signed-off-by: Inteon <42113979+inteon@users.noreply.github.com>
@liggitt
Copy link

liggitt commented Nov 2, 2021

/approve
/lgtm

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

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: inteon, liggitt

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 Nov 2, 2021
@k8s-ci-robot k8s-ci-robot merged commit 39f74b9 into kubernetes-sigs:master Nov 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@caesarxuchao caesarxuchao Awaiting requested review from caesarxuchao

@sttts sttts Awaiting requested review from sttts

@luxas luxas Awaiting requested review from luxas

Assignees

@liggitt liggitt

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. sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@inteon @liggitt @k8s-ci-robot @luxas