Skip to content

Commit 4461816

Browse files
ondrej-fabrytpounds
authored andcommitted
Update README.tmpl.md (#868)
Update README. * added -S flag to properly show errors for curl * replaced -q flag with -nv to properly show errors for wget * added github release badge from shields.io to display latest version next installation
1 parent e4df56b commit 4461816

File tree

2 files changed

+16
-20
lines changed

2 files changed

+16
-20
lines changed

README.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -68,29 +68,27 @@ Most installations are done for CI (travis, circleci etc). It's important to hav
6868
don't start to fail all builds at the same time. With golangci-lint this can happen if you
6969
use deprecated option `--enable-all` and a new linter is added or even without `--enable-all`: when one upstream linter is upgraded.
7070

71-
It's highly recommended to install a fixed version of golangci-lint.
72-
Releases are available on the [releases page](https://github.com/golangci/golangci-lint/releases).
71+
It's highly recommended to install a specific version of golangci-lint. Releases are available on the [releases page](https://github.com/golangci/golangci-lint/releases).
7372

74-
Latest version: [v1.21.0](https://github.com/golangci/golangci-lint/releases/tag/v1.21.0)
73+
Latest release: [![GitHub release](https://img.shields.io/github/release/golangci/golangci-lint.svg)]((https://github.com/golangci/golangci-lint/releases/latest))
7574

76-
Here is the recommended way to install golangci-lint:
75+
Here is the recommended way to install golangci-lint v1.21.0:
7776

7877
```bash
7978
# binary will be $(go env GOPATH)/bin/golangci-lint
80-
curl -sfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh| sh -s -- -b $(go env GOPATH)/bin v1.21.0
79+
curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.21.0
8180

8281
# or install it into ./bin/
83-
curl -sfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh| sh -s v1.21.0
82+
curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s v1.21.0
8483

8584
# In alpine linux (as it does not come with curl by default)
86-
wget -O - -q https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh| sh -s v1.21.0
85+
wget -O- -nv https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s v1.21.0
8786

8887
golangci-lint --version
8988
```
9089

91-
Periodically update version of golangci-lint: the project is under active development
92-
and is constantly being improved. But please always check for newly found issues and
93-
update if needed.
90+
It is advised that you periodically update version of golangci-lint as the project is under active development
91+
and is constantly being improved. For any problems with golangci-lint, check out recent [GitHub issues](https://github.com/golangci/golangci-lint/issues) and update if needed.
9492

9593
### MacOS
9694

README.tmpl.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -68,29 +68,27 @@ Most installations are done for CI (travis, circleci etc). It's important to hav
6868
don't start to fail all builds at the same time. With golangci-lint this can happen if you
6969
use deprecated option `--enable-all` and a new linter is added or even without `--enable-all`: when one upstream linter is upgraded.
7070

71-
It's highly recommended to install a fixed version of golangci-lint.
72-
Releases are available on the [releases page](https://github.com/golangci/golangci-lint/releases).
71+
It's highly recommended to install a specific version of golangci-lint. Releases are available on the [releases page](https://github.com/golangci/golangci-lint/releases).
7372

74-
Latest version: [{{.LatestVersion}}](https://github.com/golangci/golangci-lint/releases/tag/{{.LatestVersion}})
73+
Latest release: [![GitHub release](https://img.shields.io/github/release/golangci/golangci-lint.svg)]((https://github.com/golangci/golangci-lint/releases/latest))
7574

76-
Here is the recommended way to install golangci-lint:
75+
Here is the recommended way to install golangci-lint {{.LatestVersion}}:
7776

7877
```bash
7978
# binary will be $(go env GOPATH)/bin/golangci-lint
80-
curl -sfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh| sh -s -- -b $(go env GOPATH)/bin {{.LatestVersion}}
79+
curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin {{.LatestVersion}}
8180

8281
# or install it into ./bin/
83-
curl -sfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh| sh -s {{.LatestVersion}}
82+
curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s {{.LatestVersion}}
8483

8584
# In alpine linux (as it does not come with curl by default)
86-
wget -O - -q https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh| sh -s {{.LatestVersion}}
85+
wget -O- -nv https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s {{.LatestVersion}}
8786

8887
golangci-lint --version
8988
```
9089

91-
Periodically update version of golangci-lint: the project is under active development
92-
and is constantly being improved. But please always check for newly found issues and
93-
update if needed.
90+
It is advised that you periodically update version of golangci-lint as the project is under active development
91+
and is constantly being improved. For any problems with golangci-lint, check out recent [GitHub issues](https://github.com/golangci/golangci-lint/issues) and update if needed.
9492

9593
### MacOS
9694

0 commit comments

Comments
 (0)