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

Automatically check .golangci.reference.yml is up to date with code #4287

Open
mateusoliveira43 opened this issue Dec 26, 2023 · 1 comment
Labels
enhancement New feature or improvement no decision No decision to fix or not

Comments

@mateusoliveira43
Copy link
Contributor

Your feature request related to a problem? Please describe.

Today, the documentation from .golangci.reference.yml is not programmatically checked. This can lead to undocumented fields (example #4285). With so many available options, it is impossible to check all of them just with reviewing the yaml file.

Describe the solution you'd like.

Add a CI check to confirm that .golangci.reference.yml is up to date with code. Example implementation #4286

Describe alternatives you've considered.

Did not think about another alternative.

Additional context.

This can improve user experience with the product.

@mateusoliveira43 mateusoliveira43 added the enhancement New feature or improvement label Dec 26, 2023
@ldez ldez added the no decision No decision to fix or not label Dec 26, 2023
@chrishalbert
Copy link
Contributor

I think its ideal to tightly couple your documentation to your code and having this type of check would help ensure that. I think most engineers can admit that they are guilty of neglecting documentation at times (✋: I can) . I'm in favor of this feature! Great idea in my opinion.

@ldez ldez changed the title Automatically check .golangci.reference.yml Automatically check .golangci.reference.yml is up to date with code Mar 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or improvement no decision No decision to fix or not
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants