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

feat: Documentation reference check #4286

Conversation

mateusoliveira43
Copy link
Contributor

@mateusoliveira43 mateusoliveira43 commented Dec 26, 2023

Add documentation reference check to CI. This allows .golangci.reference.yml file to be always up to date with code.

Fixes #4287
Related to #2645

Signed-off-by: Mateus Oliveira <msouzaol@redhat.com>
@@ -1505,6 +1523,14 @@ linters-settings:
# Default: 0.8
confidence: 0.1

error-code: 1
Copy link
Contributor Author

Choose a reason for hiding this comment

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

some of the options I was not able to get help/documentation from where I found them in the code

))); err != nil {
)), func(config *mapstructure.DecoderConfig) {
config.ErrorUnused = true
if os.Getenv("HELP_RUN") == "2" {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I had cyclic imports errors here. Maybe add all envVars names to a single file? related to #3196

@ldez ldez self-requested a review December 26, 2023 16:06
@ldez ldez closed this Dec 26, 2023
@ldez
Copy link
Member

ldez commented Dec 26, 2023

Please open a dedicated issue or discuss it inside the current issue before doing something like that.

@mateusoliveira43
Copy link
Contributor Author

@ldez created the issue. Please contact me if you have any questions, I think this can increase the product quality

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Automatically check .golangci.reference.yml is up to date with code
2 participants