pipelines-as-code icon indicating copy to clipboard operation
pipelines-as-code copied to clipboard

add golangci-lint errcheck warning

Open chmouel opened this issue 1 year ago โ€ข 1 comments

we were getting this warning:

WARN [config_reader] The configuration option `linters.errcheck.exclude`
is deprecated, please use `linters.errcheck.exclude-functions`.

so removing .errcheck.txt and adding the functions to the .golangci.yml

add a comment to the go code to explain what the function does and launch golangci-lint to make sure it's all good.

Changes

Submitter Checklist

  • [ ] ๐Ÿ“ Please ensure your commit message is clear and informative. For guidance on crafting effective commit messages, refer to the How to write a git commit message guide. We prefer the commit message to be included in the PR body itself rather than a link to an external website (ie: Jira ticket).

  • [ ] โ™ฝ Before submitting a PR, run make test lint to avoid unnecessary CI processing. For an even more efficient workflow, consider installing pre-commit and running pre-commit install in the root of this repository.

  • [ ] โœจ We use linters to maintain clean and consistent code. Please ensure you've run make lint before submitting a PR. Some linters offer a --fix mode, which can be executed with the command make fix-linters (ensure markdownlint and golangci-lint tools are installed first).

  • [ ] ๐Ÿ“– If you're introducing a user-facing feature or changing existing behavior, please ensure it's properly documented.

  • [ ] ๐Ÿงช While 100% coverage isn't a requirement, we encourage unit tests for any code changes where possible.

  • [ ] ๐ŸŽ If feasible, please check if an end-to-end test can be added. See README for more details.

  • [ ] ๐Ÿ”Ž If there's any flakiness in the CI tests, don't necessarily ignore it. It's better to address the issue before merging, or provide a valid reason to bypass it if fixing isn't possible (e.g., token rate limitations).

chmouel avatar Apr 04 '24 07:04 chmouel

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 64.11%. Comparing base (2053951) to head (4f330b2).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1647   +/-   ##
=======================================
  Coverage   64.11%   64.11%           
=======================================
  Files         140      140           
  Lines       10871    10871           
=======================================
  Hits         6970     6970           
  Misses       3385     3385           
  Partials      516      516           

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar Apr 09 '24 10:04 codecov[bot]