Instructions in README are outdated and use deprecated functions

kubernetes-sigs / e2e-framework

A Go framework for end-to-end testing of components running in Kubernetes clusters.

Apache License 2.0

513 stars 100 forks source link

Instructions in README are outdated and use deprecated functions #434

Open carreter opened 3 months ago

carreter commented 3 months ago

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 commented 3 months ago

Where is it written that envfuncs.CreateKindCluster is deprecated ?

carreter commented 3 months ago

https://github.com/kubernetes-sigs/e2e-framework/blob/a4bef024d27b5f6c476f82a921e7993fc840eab2/pkg/envfuncs/kind_funcs.go#L35-L39

mbtamuli commented 2 months ago

Yes, the new function to replace that is CreateCluster

vladimirvivien commented 1 month ago

@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 commented 1 month ago

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