Skip to content

maintenance: added types to KubeConfig#loadFromOptions input #1002

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

Merged
merged 2 commits into from
Mar 4, 2023
Merged

maintenance: added types to KubeConfig#loadFromOptions input #1002

merged 2 commits into from
Mar 4, 2023

Conversation

emeraldsanto
Copy link

Summary

This PR adds stronger types to the KubeConfig#loadFromOptions method which is currently accepting any, even though all the necessary types are already defined and available to use.

@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Mar 2, 2023

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: emeraldsanto / name: Yanick Bélanger (8b2b685)

@k8s-ci-robot
Copy link
Contributor

Welcome @emeraldsanto!

It looks like this is your first PR to kubernetes-client/javascript 🎉. 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-client/javascript 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 k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. 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 Mar 2, 2023
@emeraldsanto emeraldsanto changed the title feat: added types to KubeConfig#loadFromOptions input maintenance: added types to KubeConfig#loadFromOptions input Mar 2, 2023
@brendandburns
Copy link
Contributor

Thanks for the PR, this looks fine but CI/CD is failing b/c of the stricter types.

I think we need to make some fields in the existing types optional (e.g. skipTlsVerify)

@emeraldsanto
Copy link
Author

@brendandburns good catch! I've gone ahead with the change and confirmed the tests pass locally. However that type has not been changed in 5 years so I'm worried that marking this field as optional now might be a breaking change?

@brendandburns
Copy link
Contributor

I looked at the code and I think we'll be ok. Most people are probably not including it anyway...

@brendandburns
Copy link
Contributor

/lgtm
/approve

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

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: brendandburns, emeraldsanto

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 Mar 4, 2023
@brendandburns
Copy link
Contributor

(and fwiw, adding stronger types is probably a breaking change anyway :) )

@k8s-ci-robot k8s-ci-robot merged commit 1997dfd into kubernetes-client:master Mar 4, 2023
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