Skip to content

Commit 79776b4

Browse files
committed
Fix #150: don't recommend vendoring of golangci-lint in README
1 parent 1774bf2 commit 79776b4

File tree

2 files changed

+2
-34
lines changed

2 files changed

+2
-34
lines changed

README.md

Lines changed: 1 addition & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -666,23 +666,7 @@ By doing this you won't create new issues in your code and can choose fix existi
666666
You have 2 choices:
667667
1. Use [GolangCI](https://golangci.com): this service is highly integrated with GitHub (issues are commented in the pull request) and uses a `golangci-lint` tool. For configuration use `.golangci.yml` (or toml/json).
668668
2. Use custom CI: just run `golangci-lint` in CI and check the exit code. If it's non-zero - fail the build. The main disadvantage is that you can't see issues in pull request code and would need to view the build log, then open the referenced source file to see the context.
669-
If you'd like to vendor `golangci-lint` in your repo, run:
670-
```bash
671-
go get -u github.com/golang/dep/cmd/dep
672-
dep init
673-
dep ensure -v -add github.com/golangci/golangci-lint/cmd/golangci-lint
674-
```
675-
Then add these lines to your `Gopkg.toml` file, so `dep ensure -update` won't delete the vendored `golangci-lint` code.
676-
```toml
677-
required = [
678-
"github.com/golangci/golangci-lint/cmd/golangci-lint",
679-
]
680-
```
681-
In your CI scripts, install the vendored `golangci-lint` like this:
682-
```bash
683-
go install ./vendor/github.com/golangci/golangci-lint/cmd/golangci-lint/
684-
```
685-
Vendoring `golangci-lint` saves a network request, potentially making your CI system a little more reliable.
669+
We don't recommend vendoring `golangci-lint` in your repo: you will get troubles updating `golangci-lint`. Please, use recommended way to install with the shell script: it's very fast.
686670

687671
**Does I need to run `go install`?**
688672

README.tmpl.md

Lines changed: 1 addition & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -330,23 +330,7 @@ By doing this you won't create new issues in your code and can choose fix existi
330330
You have 2 choices:
331331
1. Use [GolangCI](https://golangci.com): this service is highly integrated with GitHub (issues are commented in the pull request) and uses a `golangci-lint` tool. For configuration use `.golangci.yml` (or toml/json).
332332
2. Use custom CI: just run `golangci-lint` in CI and check the exit code. If it's non-zero - fail the build. The main disadvantage is that you can't see issues in pull request code and would need to view the build log, then open the referenced source file to see the context.
333-
If you'd like to vendor `golangci-lint` in your repo, run:
334-
```bash
335-
go get -u github.com/golang/dep/cmd/dep
336-
dep init
337-
dep ensure -v -add github.com/golangci/golangci-lint/cmd/golangci-lint
338-
```
339-
Then add these lines to your `Gopkg.toml` file, so `dep ensure -update` won't delete the vendored `golangci-lint` code.
340-
```toml
341-
required = [
342-
"github.com/golangci/golangci-lint/cmd/golangci-lint",
343-
]
344-
```
345-
In your CI scripts, install the vendored `golangci-lint` like this:
346-
```bash
347-
go install ./vendor/github.com/golangci/golangci-lint/cmd/golangci-lint/
348-
```
349-
Vendoring `golangci-lint` saves a network request, potentially making your CI system a little more reliable.
333+
We don't recommend vendoring `golangci-lint` in your repo: you will get troubles updating `golangci-lint`. Please, use recommended way to install with the shell script: it's very fast.
350334

351335
**Does I need to run `go install`?**
352336

0 commit comments

Comments
 (0)