eeafj/golangci-lint
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 1 Wiki Activity

docs: recommend binary installation for windows and linux (#1159)

Browse Source 
Relates: #1087
This commit is contained in:
Denis Isaev 2020-05-23 02:06:20 +03:00 committed by GitHub
parent 156eaaa963
commit 9119ca7e78
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 30 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
docs/src/docs/usage/install/index.mdx
View File

@ -46,7 +46,7 @@ and is constantly being improved. For any problems with `golangci-lint`, check o
### macOS ### macOS
You can also install a binary release on macOS using [brew](https://brew.sh/): You can install a binary release on macOS using [brew](https://brew.sh/):
```sh ```sh
brew install golangci/tap/golangci-lint brew install golangci/tap/golangci-lint
@ -59,14 +59,42 @@ brew upgrade golangci/tap/golangci-lint
docker run --rm -v $(pwd):/app -w /app golangci/golangci-lint:{.LatestVersion} golangci-lint run -v docker run --rm -v $(pwd):/app -w /app golangci/golangci-lint:{.LatestVersion} golangci-lint run -v
``` ```
### Linux and Windows
```sh
# binary will be $(go env GOPATH)/bin/golangci-lint
curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin {.LatestVersion}
golangci-lint --version
```
On Windows, you can run the above commands with Git Bash, which comes with [Git for Windows](https://git-scm.com/download/win).
### Install from Source ### Install from Source
Go source installations are supported for the two most recent Go releases. Note: such `go get` installation aren't guaranteed to work. We recommend using binary installation.
<details>
<summary>Why?</summary>
`go get` installation isn't recommended because of the following points:
1. some users use `-u` flag for `go get`, which upgrades our dependencies. Resulting configuration wasn't tested and isn't guaranteed to work.
2. [`go.mod`](https://github.com/golangci/golangci-lint/blob/master/go.mod) replacement directive doesn't apply. It means a user will be using patched version of `golangci-lint` if we use such replacements.
3. it's stability depends on a user's Go version (e.g. on [this compiler Go <= 1.12 bug](https://github.com/golang/go/issues/29612)).
4. we've encountered a lot of issues with Go modules hashes.
5. it allows installation from `master` branch which can't be considered stable.
6. it's slower than binary installation
</details>
<div style="margin-top: 2em;">
```sh ```sh
go get github.com/golangci/golangci-lint/cmd/golangci-lint@{.LatestVersion} go get github.com/golangci/golangci-lint/cmd/golangci-lint@{.LatestVersion}
``` ```
</div>
## Versioning Policy ## Versioning Policy
`golangci-lint` follows [semantic versioning](https://semver.org). However, due to the nature of `golangci-lint` as a code quality tool, `golangci-lint` follows [semantic versioning](https://semver.org). However, due to the nature of `golangci-lint` as a code quality tool,