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

Add tags to ignore static check on helper files #842

Merged
merged 1 commit into from
Mar 19, 2025

Conversation

denisonbarbosa
Copy link
Member

We have a lot of helper files to help us test our project and those are protected to not be built with "go build" to avoid having those in the release binary. To avoid having to update tics configuration every time we rename those files or add new ones, let's tag them and filter those out in the analysis.

@denisonbarbosa denisonbarbosa marked this pull request as ready for review March 19, 2025 10:09
@denisonbarbosa denisonbarbosa requested a review from a team as a code owner March 19, 2025 10:09
@adombeck
Copy link
Contributor

[...] those are protected to not be built with "go build" to avoid having those in
the release binary. To avoid having to update tics configuration every
time we rename those files [...]

For someone who doesn't know much about TiCS (like me :)), there's a gap in the reasoning here. I assume that:

  1. TiCS is only run on our released binaries (and we can't or don't want to change that)
  2. TiCS shows an error if a source file is not part of the released binary

If that's correct, could you please add a sentence in the commit message explaining this?

We have a lot of helper files to help us test our project and those
are protected to not be built with "go build" to avoid having those in
the release binary.

Since they are not part of what we use in production, we don't want
them listed in the static analysis checks as it would give us wrong
metrics on the results.

To avoid having to update tics configuration every time we rename
those files or add new ones, let's tag them and filter those out in
the analysis.
@denisonbarbosa denisonbarbosa force-pushed the add-tags-to-disable-tics-analysis branch from f082b7a to ddbd12a Compare March 19, 2025 10:51
@denisonbarbosa denisonbarbosa merged commit 75499a0 into main Mar 19, 2025
14 of 15 checks passed
@denisonbarbosa denisonbarbosa deleted the add-tags-to-disable-tics-analysis branch March 19, 2025 13:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants