Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update documentation and assets #2579

Merged
merged 7 commits into from
Feb 17, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ blank_issues_enabled: false
contact_links:
- name: Questions
url: https://github.com/golangci/golangci-lint/discussions
about: If you have a question, or are looking for advice, please post on our discussions forum!
about: If you have a question, or are looking for advice, please post on our Discussions forum!
- name: golangci-lint documentation
url: https://golangci-lint.run
about: Please take a look to our documenation.
about: Please take a look to our documentation.
3 changes: 3 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ updates:
directory: "/"
schedule:
interval: weekly
day: "sunday"
time: "11:00" # 11am UTC
ignore:
# ignore forked linters because of their versioning issues. TODO: fix it.
- dependency-name: "github.com/golangci/*"
Expand Down Expand Up @@ -31,5 +33,6 @@ updates:
directory: "/docs"
schedule:
interval: monthly
day: wednesday
reviewers:
- "golangci/team"
2 changes: 2 additions & 0 deletions .golangci.example.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1569,6 +1569,7 @@ linters-settings:

linters:
# Disable all linters.
# Default: false
disable-all: true
# Enable specific linter
# https://golangci-lint.run/usage/linters/#enabled-by-default-linters
Expand Down Expand Up @@ -1658,6 +1659,7 @@ linters:
- wsl

# Enable all available linters.
# Default: false
enable-all: true
# Disable specific linter
# https://golangci-lint.run/usage/linters/#disabled-by-default-linters--e--enable
Expand Down
16 changes: 9 additions & 7 deletions .goreleaser.yml
Original file line number Diff line number Diff line change
Expand Up @@ -61,13 +61,15 @@ changelog:
sort: asc
filters:
exclude:
- '^docs:'
- '^test:'
- '^dev:'
- 'README'
- 'build\(deps\): bump .* in /docs \(#\d+\)'
- Merge pull request
- Merge branch
- '(?i)^docs?:'
- '(?i)^docs\([^:]+\):'
- '(?i)^docs\[[^:]+\]:'
- '^tests?:'
- '(?i)^dev:'
- '^build\(deps\): bump .* in /docs \(#\d+\)'
- '^build\(deps\): bump .* in /\.github/peril \(#\d+\)'
- Merge pull request
- Merge branch

brews:
- tap:
Expand Down
17 changes: 17 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,23 @@
Follow the news and releases on our [twitter](https://twitter.com/golangci) and our [blog](https://medium.com/golangci).
There is the most valuable changes log:

### v1.44.1

1. updated linters:
* `bidichk`: from 0.2.1 to 0.2.2
* `errchkjson`: from 0.2.1 to 0.2.3
* `thelper`: from 0.5.0 to 0.5.1
* `tagliatelle`: from 0.3.0 to 0.3.1
* `gopsutil`: from 3.21.12 to 3.22.1
* `gci`: from 0.2.9 to 0.3.0
* `revive`: from v1.1.3 to v1.1.4
* `varnamelen`: from v0.5.0 to v0.6.0
2. documentation:
* linters: improve configuration pages
* `decorder`: fix `disable-init-func-first-check: false` elaboration
3. misc:
* fix debug output

### v1.44.0

1. new linters:
Expand Down
164 changes: 86 additions & 78 deletions README.md

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions assets/github-action-config.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"MinorVersionToConfig": {
"latest": {
"TargetVersion": "v1.44.0",
"AssetURL": "https://github.com/golangci/golangci-lint/releases/download/v1.44.0/golangci-lint-1.44.0-linux-amd64.tar.gz"
"TargetVersion": "v1.44.1",
"AssetURL": "https://github.com/golangci/golangci-lint/releases/download/v1.44.1/golangci-lint-1.44.1-linux-amd64.tar.gz"
},
"v1.10": {
"Error": "golangci-lint version 'v1.10' isn't supported: we support only v1.14.0 and later versions"
Expand Down Expand Up @@ -143,8 +143,8 @@
"AssetURL": "https://github.com/golangci/golangci-lint/releases/download/v1.43.0/golangci-lint-1.43.0-linux-amd64.tar.gz"
},
"v1.44": {
"TargetVersion": "v1.44.0",
"AssetURL": "https://github.com/golangci/golangci-lint/releases/download/v1.44.0/golangci-lint-1.44.0-linux-amd64.tar.gz"
"TargetVersion": "v1.44.1",
"AssetURL": "https://github.com/golangci/golangci-lint/releases/download/v1.44.1/golangci-lint-1.44.1-linux-amd64.tar.gz"
},
"v1.5": {
"Error": "golangci-lint version 'v1.5' isn't supported: we support only v1.14.0 and later versions"
Expand Down
5 changes: 3 additions & 2 deletions docs/src/docs/usage/install/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -88,11 +88,12 @@ On Windows, you can run the above commands with Git Bash, which comes with [Git

### Install from Source

Note: such `go get` installation aren't guaranteed to work. We recommend using binary installation.
Note: such `go install`/`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:
`go install`/`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.
Expand Down
2 changes: 1 addition & 1 deletion docs/template_data.state
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
This file stores hash of website templates to trigger Netlify rebuild when something changes, e.g. new linter is added.
b9810d4a9ec034dae53108a02b58f8c479071501e1407fb2d7651bc06d51c11f
74d6ee2c8d7eee280832398a0352caa1210f92b911be236cbbdb89bdc601fe5d
7 changes: 2 additions & 5 deletions tools/go.mod
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
module github.com/golangci/golangci-lint/tools

go 1.13
go 1.16

require github.com/goreleaser/goreleaser v0.155.0

// https://github.com/mattn/go-shellwords/pull/39
replace github.com/mattn/go-shellwords => github.com/caarlos0/go-shellwords v1.0.11
require github.com/goreleaser/goreleaser v1.5.0
Loading