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

docs: merge 'custom' and 'implementation-specific' conformance #1436

Merged
merged 1 commit into from
Oct 7, 2022

Conversation

LCaparelli
Copy link
Contributor

Signed-off-by: Lucas Caparelli [email protected]

What type of PR is this?
/kind documentation

What this PR does / why we need it:

This PR merges the concepts of custom and implementation-specific conformance into implementation-specific only in order to simplify the spec. All custom conformance mentions were replaced by implementation-specific.

Which issue(s) this PR fixes:

Fixes #640

Does this PR introduce a user-facing change?:

Changes "custom" conformance level to "implementation-specific"

@k8s-ci-robot k8s-ci-robot added the kind/documentation Categorizes issue or PR as related to documentation. label Oct 5, 2022
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Oct 5, 2022

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: LCaparelli / name: Lucas Caparelli (376e789)

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Oct 5, 2022
@k8s-ci-robot
Copy link
Contributor

Welcome @LCaparelli!

It looks like this is your first PR to kubernetes-sigs/gateway-api 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/gateway-api has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot
Copy link
Contributor

Hi @LCaparelli. Thanks for your PR.

I'm waiting for a kubernetes-sigs 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.

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Oct 5, 2022
@k8s-ci-robot k8s-ci-robot requested review from bowei and robscott October 5, 2022 22:24
@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 Oct 5, 2022
@LCaparelli
Copy link
Contributor Author

I also changed these in the GEPs, please let know if that's unwanted.

@LCaparelli LCaparelli changed the title docs: merge 'custom' and 'implementation-specific' conformance [WIP] docs: merge 'custom' and 'implementation-specific' conformance Oct 5, 2022
@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 5, 2022
@LCaparelli LCaparelli changed the title [WIP] docs: merge 'custom' and 'implementation-specific' conformance docs: merge 'custom' and 'implementation-specific' conformance Oct 5, 2022
@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 Oct 5, 2022
@robscott
Copy link
Member

robscott commented Oct 6, 2022

Thanks @LCaparelli! This looks like a good simplification to me but will defer to another maintainer to confirm since this is changing our language around conformance levels.

/ok-to-test
/lgtm

/cc @youngnick @shaneutt

@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 Oct 6, 2022
@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 6, 2022
@LCaparelli
Copy link
Contributor Author

Weird, runs fine locally 🤔

❯ go version
go version go1.18.7 linux/amd64
❯ git push
Everything up-to-date
❯ make verify
hack/verify-all.sh -v
Skipping hack/../hack/verify-all.sh
Verified 178 file headers match boilerplate
SUCCESS: hack/../hack/verify-boilerplate.sh 
make[1]: Entering directory '/home/lucascaparelli/gitrepos/gateway-api'
hack/update-codegen.sh
Generating CRDs
2022/10/06 10:10:37 generating standard CRD for Gateway.gateway.networking.k8s.io
2022/10/06 10:10:37 generating standard CRD for GatewayClass.gateway.networking.k8s.io
2022/10/06 10:10:37 generating standard CRD for HTTPRoute.gateway.networking.k8s.io
2022/10/06 10:10:37 generating experimental CRD for GatewayClass.gateway.networking.k8s.io
2022/10/06 10:10:37 generating experimental CRD for TCPRoute.gateway.networking.k8s.io
2022/10/06 10:10:37 generating experimental CRD for UDPRoute.gateway.networking.k8s.io
2022/10/06 10:10:37 generating experimental CRD for GRPCRoute.gateway.networking.k8s.io
2022/10/06 10:10:37 generating experimental CRD for HTTPRoute.gateway.networking.k8s.io
2022/10/06 10:10:37 generating experimental CRD for TLSRoute.gateway.networking.k8s.io
2022/10/06 10:10:37 generating experimental CRD for ReferenceGrant.gateway.networking.k8s.io
2022/10/06 10:10:37 generating experimental CRD for Gateway.gateway.networking.k8s.io
Generating clientset at sigs.k8s.io/gateway-api/pkg/client/clientset
Generating listers at sigs.k8s.io/gateway-api/pkg/client/listers
Generating informers at sigs.k8s.io/gateway-api/pkg/client/informers
Generating v1alpha2 register at sigs.k8s.io/gateway-api/apis/v1alpha2
Generating v1alpha2 deepcopy at sigs.k8s.io/gateway-api/apis/v1alpha2
Generating v1beta1 register at sigs.k8s.io/gateway-api/apis/v1beta1
Generating v1beta1 deepcopy at sigs.k8s.io/gateway-api/apis/v1beta1
hack/update-webhook-yaml.sh
No version requested with BASE_REF, nothing to do.
make[1]: Leaving directory '/home/lucascaparelli/gitrepos/gateway-api'
SUCCESS: hack/../hack/verify-codegen.sh 

Fails on CI:

Generating v1beta1 register at sigs.k8s.io/gateway-api/apis/v1beta1
Generating v1beta1 deepcopy at sigs.k8s.io/gateway-api/apis/v1beta1
hack/update-webhook-yaml.sh
No version requested with BASE_REF, nothing to do.
make[1]: Leaving directory '/home/prow/go/src/sigs.k8s.io/gateway-api'
Uncommitted changes in generated sources:
 M pkg/client/clientset/versioned/fake/register.go
 M pkg/client/clientset/versioned/scheme/register.go
Test FAILED: hack/../hack/verify-codegen.sh 

@LCaparelli
Copy link
Contributor Author

I'll take a closer look at what the script does, had some trouble with an outdated kubectl on my side, might be picking up some other old dependency on my end.

@robscott
Copy link
Member

robscott commented Oct 6, 2022

Hey @LCaparelli, sorry for the confusion here, I think the k8s codegen requires that you're using go1.19 now.

@robscott robscott added this to the v0.6.0 milestone Oct 6, 2022
@LCaparelli
Copy link
Contributor Author

Hey @LCaparelli, sorry for the confusion here, I think the k8s codegen requires that you're using go1.19 now.

Ah yes, that apparently did the trick (at least it changed the two files the CI was complaining about), thanks!

Adding a quick version check at the codegen script sounds reasonable @robscott? And if so, it it ok to include in this PR?

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 6, 2022
@robscott
Copy link
Member

robscott commented Oct 6, 2022

Thanks @LCaparelli! This LGTM, will defer to @youngnick or @shaneutt to formally sign off on this change though.

Adding a quick version check at the codegen script sounds reasonable @robscott? And if so, it it ok to include in this PR?

This is a great idea, do you mind filing a follow up PR for that?

Copy link
Member

@shaneutt shaneutt left a comment

Choose a reason for hiding this comment

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

Yep, I like this change 👍

/lgtm

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

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: LCaparelli, shaneutt

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 Oct 7, 2022
@k8s-ci-robot k8s-ci-robot merged commit 006a257 into kubernetes-sigs:main Oct 7, 2022
@LCaparelli
Copy link
Contributor Author

Thanks @robscott @shaneutt! Follow-up for version check: #1443

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. 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. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
4 participants