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

Document supported version(s) of Go #886

Open
mattwelke opened this issue Feb 28, 2024 · 2 comments
Open

Document supported version(s) of Go #886

mattwelke opened this issue Feb 28, 2024 · 2 comments

Comments

@mattwelke
Copy link

mattwelke commented Feb 28, 2024

A GitHub user notes in #880 (comment) that the presence of 1.21 in https://github.com/kubernetes-sigs/controller-tools/blob/master/go.mod#L3, according to Go conventions, doesn't mean that the project doesn't support any other version of Go than 1.21. It simply means that the Go code contained within it requires at least Go 1.21 to compile.

Of course at the same time, it makes sense that a project may only support up to a certain Go version, because of bugs present in the new version, breaking changes, or simply because the maintainers want to take a more careful approach where they vet new versions of Go first with the code. So stating "only Go 1.21 is supported right now" is perfectly valid.

I propose that information be documented in the README that conveys which Go version(s) are supported (is it just 1.21?).

@sbueringer
Copy link
Member

Makes sense to me!

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

2 participants