Skip to content

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

Open
@mateusoliveira43

Description

@mateusoliveira43

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or improvementno decisionNo decision to fix or not

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions