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

docs: define linter deprecation cycle (#4474)

Browse Source
This commit is contained in:
Ludovic Fernandez 2024-03-11 17:59:24 +01:00 committed by GitHub
parent 167204c1fd
commit bb30bbe658
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -151,6 +151,29 @@ As such, we recommend using the fixed minor version and fixed or the latest patc
For example, in our [GitHub Action](https://github.com/golangci/golangci-lint-action) we require users to explicitly set the minor version of `golangci-lint`
and we always use the latest patch version.
## Linter Deprecation Cycle
A linter can be deprecated for various reasons, e.g. the linter stops working with a newer version of Go or the author has abandoned its linter.
The deprecation of a linter will follow 3 phases:
1. **Display of a warning message**: The linter can still be used (unless it's completely non-functional), but it's recommended to remove it from your configuration.
2. **Display of an error message**: At this point, you should remove the linter. The original implementation is replaced by a placeholder that does nothing.
3. **Removal of the linter** from golangci-lint.
Each phase corresponds to a minor version:
- v1.0.0 -> warning message
- v1.1.0 -> error message
- v1.2.0 -> linter removed
Otherwise, the deprecated linters are removed from presets immediately when they are deprecated (phase 1).
We will provide clear information about those changes on different supports: changelog, logs, social network, etc.
We consider the removal of a linter as non-breaking changes for golangci-lint itself.
No major version will be created when a linter is removed.
## Next
[Quick Start: how to use `golangci-lint`](/usage/quick-start).