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

doc: improve installation section (#3610)

Browse Source
This commit is contained in:
Ludovic Fernandez 2023-02-18 12:32:57 +01:00 committed by GitHub
parent fe53ca0cd4
commit defde13179
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 29 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -44,30 +44,16 @@ and is constantly being improved. For any problems with `golangci-lint`, check o
## Local Installation ## Local Installation
### macOS ### Binaries
You can install a binary release on macOS using [brew](https://brew.sh/):
```sh ```sh
brew install golangci-lint # binary will be $(go env GOPATH)/bin/golangci-lint
brew upgrade 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
``` ```
Note: Previously we used a [homebrew tap](https://github.com/golangci/homebrew-tap). We recommend using official formula instead of the tap, but sometimes the most recent release On Windows, you can run the above commands with Git Bash, which comes with [Git for Windows](https://git-scm.com/download/win).
isn't immediately available via homebrew core due to manual updates that need to occur from homebrew core maintainers. In this case, the tap formula, which is updated automatically,
can be used to install the latest version of `golangci-lint`:
```sh
brew tap golangci/tap
brew install golangci/tap/golangci-lint
```
It can also be installed through [macports](https://www.macports.org/)
The macports installation mode is community driven, and not officially maintained by golangci team.
```sh
sudo port install golangci-lint
```
### Docker ### Docker
@ -85,16 +71,33 @@ Colored output:
docker run -t --rm -v $(pwd):/app -w /app golangci/golangci-lint:{.LatestVersion} golangci-lint run -v docker run -t --rm -v $(pwd):/app -w /app golangci/golangci-lint:{.LatestVersion} golangci-lint run -v
``` ```
### Linux and Windows ### macOS
Note: brew can use a non-expected version of Go to build the binary,
so we recommend either using our binaries or be sure of the version of Go used to build.
You can install a binary release on macOS using [brew](https://brew.sh/):
```sh ```sh
# binary will be $(go env GOPATH)/bin/golangci-lint brew install golangci-lint
curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin {.LatestVersion} brew upgrade golangci-lint
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). Note: Previously we used a [homebrew tap](https://github.com/golangci/homebrew-tap). We recommend using official formula instead of the tap, but sometimes the most recent release
isn't immediately available via homebrew core due to manual updates that need to occur from homebrew core maintainers. In this case, the tap formula, which is updated automatically,
can be used to install the latest version of `golangci-lint`:
```sh
brew tap golangci/tap
brew install golangci/tap/golangci-lint
```
It can also be installed through [macports](https://www.macports.org/)
The macports installation mode is community driven, and not officially maintained by golangci team.
```sh
sudo port install golangci-lint
```
### Install from Source ### Install from Source