Skip to content

docs: define linter deprecation cycle #4474

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Mar 11, 2024
Merged

docs: define linter deprecation cycle #4474

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f8f0e26
docs: define linter deprecated cycle
ldez Mar 9, 2024
40dabcc
review
ldez Mar 9, 2024
2060750
review
ldez Mar 9, 2024
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
23 changes: 23 additions & 0 deletions docs/src/docs/usage/install/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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. A warning message will be displayed: you can still use it (except if it doesn't work at all anymore), but it's recommended to remove it from your configuration.
2. An error message will be displayed: now you should remove the linter. The implementation is replaced by a fake linter that does nothing.
3. The linter is removed from golangci-lint.

Each phase corresponds to a minor version:

- v1.100.0 -> warning message
- v1.101.0 -> error message
- v1.102.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).