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

Instructions in README are outdated and use deprecated functions #434

Open
carreter opened this issue Jun 28, 2024 · 5 comments
Open

Instructions in README are outdated and use deprecated functions #434

carreter opened this issue Jun 28, 2024 · 5 comments

Comments

@carreter
Copy link

I'm working through setting up some e2e tests and noticed that the README.md of this repo is outdated. Things I've noticed so far:

  • cluster creation with envfuncs.CreateKindCluster is deprecated

I'll keep adding to this as I go along.

@przemolb
Copy link

przemolb commented Jul 2, 2024

Where is it written that envfuncs.CreateKindCluster is deprecated ?

@carreter
Copy link
Author

carreter commented Jul 3, 2024

// Deprecated: This handler has been deprecated in favor of CreateCluster which can now accept
// support.ClusterProvider type as input in order to setup the cluster using right providers
func CreateKindCluster(clusterName string) env.Func {
return CreateCluster(kind.NewProvider(), clusterName)
}

@mbtamuli
Copy link

mbtamuli commented Aug 1, 2024

Yes, the new function to replace that is CreateCluster

@vladimirvivien
Copy link
Contributor

@carreter thanks for pointing this out. It's possible there is outdated info in the project.
It's been evolving and some documentation will fall through the cracks.
Thanks again for using the project.

@carreter
Copy link
Author

I'll put up a PR to clean up what I found!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants