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

Update kep template #2154

Closed
wants to merge 5 commits into from
Closed

Conversation

MorrisLaw
Copy link
Member

This PR is to address the following needs that arose from this slack convo:

  • "Add an "Open Questions" section to KEPs; in addition to the unresolved tag, easy win, all that has to be done is adding the field"
  • "Make the test plan section more specific—get feedback from SIG Testing and SIG Arch (conformance) about what they’re looking for [Conformance group ack’ed request, working on it]"
  • "Use participating or participating-groups, instead of participating-sigs (other governance bodies could be stakeholders)"

I'm not 100% sure how this information should be added, so here is my attempt at doing so.

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. area/provider/aws Issues or PRs related to aws provider area/provider/azure Issues or PRs related to azure provider kind/kep Categorizes KEP tracking issues and PRs modifying the KEP directory sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. sig/apps Categorizes an issue or PR as relevant to SIG Apps. sig/architecture Categorizes an issue or PR as relevant to SIG Architecture. labels Nov 16, 2020
@k8s-ci-robot k8s-ci-robot added sig/auth Categorizes an issue or PR as relevant to SIG Auth. sig/autoscaling Categorizes an issue or PR as relevant to SIG Autoscaling. sig/cli Categorizes an issue or PR as relevant to SIG CLI. sig/cloud-provider Categorizes an issue or PR as relevant to SIG Cloud Provider. sig/cluster-lifecycle Categorizes an issue or PR as relevant to SIG Cluster Lifecycle. sig/contributor-experience Categorizes an issue or PR as relevant to SIG Contributor Experience. sig/instrumentation Categorizes an issue or PR as relevant to SIG Instrumentation. sig/multicluster Categorizes an issue or PR as relevant to SIG Multicluster. sig/network Categorizes an issue or PR as relevant to SIG Network. sig/node Categorizes an issue or PR as relevant to SIG Node. sig/release Categorizes an issue or PR as relevant to SIG Release. sig/scheduling Categorizes an issue or PR as relevant to SIG Scheduling. sig/storage Categorizes an issue or PR as relevant to SIG Storage. sig/testing Categorizes an issue or PR as relevant to SIG Testing. sig/windows Categorizes an issue or PR as relevant to SIG Windows. labels Nov 16, 2020
@ehashman
Copy link
Member

ehashman commented Dec 2, 2020

/assign

@@ -175,7 +175,7 @@ Metadata items:
this SIG will take responsibility for the bulk of those artifacts.
* Sigs are listed as `sig-abc-def`, where the name matches the
directory entry in the `kubernetes/community` repo.
* **participating-sigs** Optional
* **participating-groups** Optional
* A list of SIGs that are involved or impacted by this KEP.

Choose a reason for hiding this comment

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

we changed sigs to groups, but the explanatory note below still only refers to sigs.. maybe "A list of SIGs, WGs and other groups..." (is there something other than a SIG/WG?)

Copy link
Member Author

Choose a reason for hiding this comment

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

Ahhh nice catch @kikisdeliveryservice !

I'll update this

Copy link
Member

Choose a reason for hiding this comment

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

there are committees too (e.g., code of conduct committee)

@johnbelamaric
Copy link
Member

Couple things:

  1. I would just change the template, not every KEP
  2. To support that, participating-sigs could still be valid but removed from the template.
  3. You'll need to update the kepval code to validate against other groups, not just the list of SIGs. If both groups and sigs are defined, you should puke on that too.

@k8s-ci-robot k8s-ci-robot removed the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Dec 15, 2020
@k8s-ci-robot
Copy link
Contributor

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.


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

@k8s-ci-robot k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Dec 15, 2020
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: MorrisLaw
To complete the pull request process, please assign jeremyrickard after the PR has been reviewed.
You can assign the PR to them by writing /assign @jeremyrickard in a comment when ready.

The full list of commands accepted by this bot can be found 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 cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Dec 15, 2020
@k8s-ci-robot
Copy link
Contributor

@MorrisLaw: The following test failed, say /retest to rerun all failed tests:

Test name Commit Details Rerun command
pull-enhancements-verify 946926c link /test pull-enhancements-verify

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

@MorrisLaw
Copy link
Member Author

If both groups and sigs are defined, you should puke on that too.

Could you clarify this please @johnbelamaric. I'm not too familiar with kepval. But are you suggesting to:

Also, how do we determine groups @johnbelamaric @kikisdeliveryservice? I found this description of community groups. Should we also include User Groups? I'm hoping to find a finite list, other groups seems a bit too ambiguous, especially if we hope to validate against that.

@MorrisLaw
Copy link
Member Author

@johnbelamaric ^

@johnbelamaric
Copy link
Member

If both groups and sigs are defined, you should puke on that too.

Could you clarify this please @johnbelamaric. I'm not too familiar with kepval. But are you suggesting to:

  • Update the Proposal struct, here, to include ParticipatingWGs and ParticipatingCommittees ?

No, I don't think we need to differentiate. I am just saying let's not change every KEP to say "group", but instead allow "sigs" or "groups". Maybe others will disagree though as it does make Proposals a little hacky.

Also, how do we determine groups @johnbelamaric @kikisdeliveryservice? I found this description of community groups. Should we also include User Groups? I'm hoping to find a finite list, other groups seems a bit too ambiguous, especially if we hope to validate against that.

No, those are for kepctl query command. But the good news is it looks like all groups are already in the validation: https://github.com/kubernetes/enhancements/blob/master/pkg/legacy/keps/validations/yaml.go#L88

You'll need to update the validations there to allow the sigs or groups, and to fail if more than one is filled out and they are not the same (you could set the empty one to the same value as the filled one).

@k8s-ci-robot
Copy link
Contributor

@MorrisLaw: PR needs rebase.

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.

@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 3, 2021
@neolit123 neolit123 removed the sig/cluster-lifecycle Categorizes an issue or PR as relevant to SIG Cluster Lifecycle. label Mar 11, 2021
@ehashman
Copy link
Member

I'm going to close this for now and suggest we rebase when you have time to pick this back up, @MorrisLaw!

/close

@k8s-ci-robot
Copy link
Contributor

@ehashman: Closed this PR.

In response to this:

I'm going to close this for now and suggest we rebase when you have time to pick this back up, @MorrisLaw!

/close

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/provider/aws Issues or PRs related to aws provider area/provider/azure Issues or PRs related to azure provider cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/kep Categorizes KEP tracking issues and PRs modifying the KEP directory needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. sig/apps Categorizes an issue or PR as relevant to SIG Apps. sig/architecture Categorizes an issue or PR as relevant to SIG Architecture. sig/auth Categorizes an issue or PR as relevant to SIG Auth. sig/autoscaling Categorizes an issue or PR as relevant to SIG Autoscaling. sig/cli Categorizes an issue or PR as relevant to SIG CLI. sig/cloud-provider Categorizes an issue or PR as relevant to SIG Cloud Provider. sig/contributor-experience Categorizes an issue or PR as relevant to SIG Contributor Experience. sig/instrumentation Categorizes an issue or PR as relevant to SIG Instrumentation. sig/multicluster Categorizes an issue or PR as relevant to SIG Multicluster. sig/network Categorizes an issue or PR as relevant to SIG Network. sig/node Categorizes an issue or PR as relevant to SIG Node. sig/release Categorizes an issue or PR as relevant to SIG Release. sig/scheduling Categorizes an issue or PR as relevant to SIG Scheduling. sig/storage Categorizes an issue or PR as relevant to SIG Storage. sig/testing Categorizes an issue or PR as relevant to SIG Testing. sig/windows Categorizes an issue or PR as relevant to SIG Windows. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants