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

fix doc of types.go of node #114065

Merged
merged 2 commits into from Jan 10, 2023
Merged

fix doc of types.go of node #114065

merged 2 commits into from Jan 10, 2023

Conversation

ruquanzhao
Copy link
Member

@ruquanzhao ruquanzhao commented Nov 22, 2022 •
edited

Signed-off-by: Ruquan Zhao ruquan.zhao@arm.com

What type of PR is this?

/kind cleanup
/kind documentation

What this PR does / why we need it:

Which issue(s) this PR fixes:

Fixes #113438

Special notes for your reviewer:

Does this PR introduce a user-facing change?

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

fix doc of types.go of node
568fede 
Signed-off-by: Ruquan Zhao <ruquan.zhao@arm.com>
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. kind/documentation Categorizes issue or PR as related to documentation. labels Nov 22, 2022
@k8s-ci-robot
Copy link
Contributor

Please note that we're already in Test Freeze for the release-1.26 branch. This means every merged PR will be automatically fast-forwarded via the periodic ci-fast-forward job to the release branch of the upcoming v1.26.0 release.

Fast forwards are scheduled to happen every 6 hours, whereas the most recent run was: Tue Nov 22 03:29:08 UTC 2022.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Nov 22, 2022
@k8s-ci-robot k8s-ci-robot added the kind/api-change Categorizes issue or PR as related to adding, removing, or otherwise changing an API label Nov 22, 2022
@k8s-ci-robot k8s-ci-robot added sig/node Categorizes an issue or PR as relevant to SIG Node. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. labels Nov 22, 2022
@k8s-ci-robot
Copy link
Contributor

Hi @ruquanzhao. Thanks for your PR.

I'm waiting for a kubernetes 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/test-infra repository.

@ruquanzhao
Copy link
Member Author

fixes #113438

@k8s-triage-robot
Copy link

This PR may require API review.

If so, when the changes are ready, complete the pre-review checklist and request an API review.

Status of requested reviews is tracked in the API Review project.

@aimuz
Copy link
Contributor

aimuz commented Nov 23, 2022

/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 Nov 23, 2022
@ruquanzhao
Copy link
Member Author

/test pull-kubernetes-update

update auto generated files
05700b1 
Signed-off-by: Ruquan Zhao ruquan.zhao@arm.com
@k8s-ci-robot k8s-ci-robot added area/code-generation sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. labels Nov 23, 2022
@ruquanzhao ruquanzhao mentioned this pull request Nov 24, 2022
Open
@chiukapoor
Copy link
Contributor

LGTM

@fedebongio
Copy link
Contributor

/remove-sig api-machinery

@k8s-ci-robot k8s-ci-robot removed the sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. label Nov 29, 2022
@chiukapoor chiukapoor mentioned this pull request Dec 2, 2022
Closed
9 tasks
@bart0sh
Copy link
Contributor

bart0sh commented Dec 14, 2022

/release-note-none
/priority important-longterm
/triage accepted

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. labels Dec 14, 2022
@bart0sh bart0sh moved this from Triage to Needs Reviewer in SIG Node PR Triage Dec 14, 2022
bart0sh
bart0sh reviewed Jan 2, 2023
View reviewed changes
pkg/apis/node/types.go
@@ -47,13 +48,13 @@ type RuntimeClass struct {
// immutable.
Handler string
Copy link
Contributor

Choose a reason for hiding this comment

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

@ruquanzhao Thank you for your PR. Can you explain this type of changes, please? Why do you prefer to use lowercased names for capitalised fields?

Copy link
Member Author

Choose a reason for hiding this comment

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

This is about issue #113438.

In a word, using lowercased names will make the generated docs and field names match in https://github.com/kubernetes/kubernetes/blob/master/api/openapi-spec/swagger.json

Is this make sense to you?

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks for the explanations.
/lgtm

@bart0sh
Copy link
Contributor

bart0sh commented Jan 2, 2023

/assign

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

LGTM label has been added.

Git tree hash: 9839d5adadc2dd50f6c1641e5e21e969e350e76c

@bart0sh bart0sh moved this from Needs Reviewer to Needs Approver in SIG Node PR Triage Jan 3, 2023
@bart0sh
Copy link
Contributor

bart0sh commented Jan 3, 2023

/assign @derekwaynecarr @mrunalp @dchen1107

@ruquanzhao
Copy link
Member Author

friendly ping 😀 @liggitt

@liggitt
Copy link
Member

liggitt commented Jan 10, 2023

/lgtm
/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: chiukapoor, liggitt, ruquanzhao

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 Jan 10, 2023
@k8s-ci-robot k8s-ci-robot merged commit 2d08117 into kubernetes:master Jan 10, 2023
SIG Node PR Triage automation moved this from Needs Approver to Done Jan 10, 2023
@k8s-ci-robot k8s-ci-robot added this to the v1.27 milestone Jan 10, 2023
@ruquanzhao ruquanzhao mentioned this pull request Jun 15, 2023
Closed
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bart0sh bart0sh bart0sh left review comments

@chiukapoor chiukapoor chiukapoor approved these changes

@dchen1107 dchen1107 Awaiting requested review from dchen1107

@derekwaynecarr derekwaynecarr Awaiting requested review from derekwaynecarr

Assignees

@mrunalp mrunalp

@liggitt liggitt

@derekwaynecarr derekwaynecarr

@dchen1107 dchen1107

@bart0sh bart0sh

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/code-generation cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/api-change Categorizes issue or PR as related to adding, removing, or otherwise changing an API kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. kind/documentation Categorizes issue or PR as related to documentation. 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. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. release-note-none Denotes a PR that doesn't merit a release note. sig/node Categorizes an issue or PR as relevant to SIG Node. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
SIG Node PR Triage
Done
Milestone
v1.27
Development

Successfully merging this pull request may close these issues.

API doc should use the field name in description