From 635cf8958b9eaeb163184ee821c73f746d080c59 Mon Sep 17 00:00:00 2001 From: Oleksandr Redko Date: Wed, 12 Feb 2025 14:01:09 +0200 Subject: [PATCH] docs: update install from sources paragraph (#5397) --- docs/src/docs/welcome/install.mdx | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/src/docs/welcome/install.mdx b/docs/src/docs/welcome/install.mdx index 9445c9e2a3bf..628c05d058fe 100644 --- a/docs/src/docs/welcome/install.mdx +++ b/docs/src/docs/welcome/install.mdx @@ -134,18 +134,18 @@ docker run -t --rm -v $(pwd):/app -w /app golangci/golangci-lint:{.LatestVersion ### Install from Sources -Such `go install`/`go get`, "tools pattern", and `tool` command/directives installations aren't guaranteed to work. +Using `go install`/`go get`, "tools pattern", and `tool` command/directives installations aren't guaranteed to work. We recommend using binary installation. -Those installations aren't recommended because of the following points: +These installations aren't recommended because of the following points: -1. Those installations are compiling golangci-lint locally, the Go version used to build will depend on your local Go version. -2. Some users use `-u` flag for `go get`, which upgrades our dependencies. Resulting binary was not tested and is not guaranteed to work. -3. When using "tools pattern" or and `tool` command/directives, the dependencies of a tool can modify the dependencies of another or your project. Resulting binary was not tested and is not guaranteed to work. -4. We've encountered issues with Go modules hashes due to unexpected recreation of dependency tags. -5. `go.mod` replacement directives don't apply transitively. It means a user will be using patched version of `golangci-lint` if we use such replacements. -6. It allows installation from main branch which can't be considered stable. +1. These installations compile golangci-lint locally. The Go version used to build will depend on your local Go version. +2. Some users use the `-u` flag for `go get`, which upgrades our dependencies. The resulting binary was not tested and is not guaranteed to work. +3. When using the "tools pattern" or `tool` command/directives, the dependencies of a tool can modify the dependencies of another tool or your project. The resulting binary was not tested and is not guaranteed to work. +4. We've encountered issues with Go module hashes due to the unexpected recreation of dependency tags. +5. `go.mod` replacement directives don't apply transitively. It means a user will be using a patched version of `golangci-lint` if we use such replacements. +6. It allows installation from the main branch, which can't be considered stable. 7. It's slower than binary installation. ```sh