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

Update installation & contribution instructions & add Makefile #45

Merged
merged 1 commit into from
Mar 28, 2020

Conversation

radeksimko
Copy link
Member

This change effectively enforces developers to build through the make target
and prevents server of version 0.0.0 from ever appearing in the wild.

As for the makefile logic:

  • if the version is not provided we source the latest one from GitHub API
  • in the "happy path" (being online and GitHub's API working correctly) make build "just works"
  • otherwise (e.g. when offline) we can still build e.g. via VERSION=0.1.0 make build

@radeksimko radeksimko added documentation Improvements or additions to documentation ci Continuous integration/delivery related labels Mar 26, 2020
@radeksimko radeksimko requested a review from a team March 26, 2020 08:26
@radeksimko radeksimko merged commit 2af6b4e into master Mar 28, 2020
@radeksimko radeksimko deleted the makefile-build branch March 28, 2020 21:04
@tommyknows
Copy link

Sorry for chiming in here, but I'm not quite sure why this has been introduced.
This change prevents people from just installing the language server through go get:

$> go get github.com/hashicorp/terraform-ls
$> terraform-ls
panic: Please use 'make build' to compile and install

goroutine 1 [running]:
github.com/hashicorp/terraform-ls/version.init.0()
        /Users/ramon/Documents/go/pkg/mod/github.com/hashicorp/terraform-ls@v0.2.0/version/version.go:27 +0xc5

I don't see why a server version 0.0.0 should explicitly be avoided, could you elaborate?
It would be nice if this project was just go-gettable like pretty much every other Go project.

@ghost
Copy link

ghost commented Jun 12, 2020

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 and limited conversation to collaborators Jun 12, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
ci Continuous integration/delivery related documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants