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.

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

Conversation

ldez
Copy link
Member

@ldez ldez commented Mar 9, 2024

I feel like we agree on my proposal, and then I propose to explain it in the documentation.

Fixes #1987

@ldez ldez added enhancement New feature or improvement area: docs labels Mar 9, 2024
@ldez ldez added this to the next milestone Mar 9, 2024
@ldez ldez changed the title docs: define linter deprecated cycle docs: define linter deprecation cycle Mar 9, 2024
Copy link
Member

@bombsimon bombsimon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could, given that the new plugin system lands, write a note about that. Because people will get upset because their favorite linter that works great with Go 1.13 now is gone! We can then add a note saying that the consumer of the linter can implement that exact linter as a plugin and keep using it.

We don't have to go into detail, just saying that it's possible and link to those parts of the docs.

Co-authored-by: Simon Sawert <[email protected]>
@ldez
Copy link
Member Author

ldez commented Mar 9, 2024

We could, given that the new plugin system lands, write a note about that.

I agree.
For now, the PR about the new plugin system is not merged, I don't know if I have to wait again.
If there is no feedback by tomorrow, on PR about plugins, then I will merge it and add a link to the deprecation section inside this PR.

Copy link
Member

@alexandear alexandear left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ldez
Copy link
Member Author

ldez commented Mar 11, 2024

We can then add a note saying that the consumer of the linter can implement that exact linter as a plugin and keep using it.

After more thinking, we can't recommend/suggest using a plugin for a deprecated linter.

The linter needs to be modified, but if it is archived it will not be possible.

And if the linter doesn't work with the current Go version, it will not work, even as a plugin, even with an older version of Go, because our code base also depends on a minimal Go version.

Talking about plugins in this section will be confusing.

@ldez ldez merged commit bb30bbe into golangci:master Mar 11, 2024
@ldez ldez deleted the feat/doc-linter-deprecation branch March 11, 2024 16:59
Copy link
Contributor

@Antonboom Antonboom left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: docs enhancement New feature or improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

discuss about design deprecation cycle (how to handle deprecated linter)
4 participants