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

Add build environment details to version output #127

Closed
radeksimko opened this issue Jun 1, 2020 · 4 comments · Fixed by #407
Closed

Add build environment details to version output #127

radeksimko opened this issue Jun 1, 2020 · 4 comments · Fixed by #407
Labels
ci Continuous integration/delivery related good first issue Good for newcomers

Comments

@radeksimko
Copy link
Member

Current Version

v0.2.1

Use-cases

As mentioned in #88 there are cases when user may decide to compile the language server in their own environment.

While custom-compiled binaries and bugs stemming from differences in build environment should be fairly uncommon, they do exist and can be challenging to debug. As mentioned in the linked thread Go itself does not provide ways of prescribing the build environment yet - e.g. there is no way of guaranteeing what Go version, compiler (cgo/gc), nor compilation flags will be used.

Maintainers should at least have an easy way of discovering custom builds to aid with initial issue triaging and debugging.

Attempted Solutions

Enforce building via makefile, which breaks cross-platform compatibility and can appear unnatural to seasoned Go developers who are used to run just native go build/install. It also enforces testing via makefile, which is suboptimal.

Proposal

Add details about build environment to version output, e.g.

v0.2.1-dev
go1.14.3 darwin/amd64 (compiler: gc)
@radeksimko radeksimko added the ci Continuous integration/delivery related label Jun 1, 2020
@radeksimko radeksimko added the good first issue Good for newcomers label Jun 22, 2020
@radeksimko
Copy link
Member Author

@aeschright I think this would likely break the logic here https://github.com/hashicorp/vscode-terraform/blob/1c882b35bb52e834214fad186c167f8ecaf04804/src/languageServerInstaller.ts#L33 - it may be worth just cutting out the first line of output, alternatively you could wait for #184

@aeschright
Copy link
Contributor

I think getting the JSON output in first would be my preference.

@radeksimko
Copy link
Member Author

As mentioned in #341 (comment) we should also consider reporting whether, or perhaps when particular go generate ran.

@ghost
Copy link

ghost commented Apr 4, 2021

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the context necessary to investigate further.

@ghost ghost locked as resolved and limited conversation to collaborators Apr 4, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
ci Continuous integration/delivery related good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants