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: Please state minimum Go version #9321

Closed
magnusbaeck opened this issue Dec 1, 2018 · 2 comments · Fixed by #14400
Closed

Docs: Please state minimum Go version #9321

magnusbaeck opened this issue Dec 1, 2018 · 2 comments · Fixed by #14400

Comments

@magnusbaeck
Copy link
Contributor

The documentation at https://www.elastic.co/guide/en/beats/devguide/current/newbeat-getting-ready.html (and possibly other developer documentation) only tells the user to install Go but doesn't mention the minimum version required.

I think that paragraph should include such information since Beats has specific Go compiler requirements (at least 1.9 must be used because of type aliases) and the error messages when your Go compiler is too old can be pretty confusing.

Another option could be to introduce a version check in one of the makefiles so that the build fails if a too-old compiler is used.

@ph ph added the docs label Dec 3, 2018
@ph
Copy link
Contributor

ph commented Dec 3, 2018

We should use the version defined in .go-version when we generate the doc so we don't have to keep track of updating that file.

@dedemorton
Copy link
Contributor

Sorry, this issue got lost in the queue. We did update the docs quite a while ago to include the go version. Closed in #14400

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

Successfully merging a pull request may close this issue.

3 participants