fixes: enable golanci-lint in CI, fix complaints.

[klihub]

This patch set

• adds a local [golang]ci-lint Makefile target and hooks it in to pr-checks
• addresses golangci-lint complaints
• adds CI golangci-lint workflow

[elezar]

Do we want to specify the version, or should we just use the "default"?

[klihub]

I'm not sure what would make the most sense here. I simply took the provided sample workflow as a basis for this, then bumped the version to the latest release, which I then also used locally for linting.

Looking at the action implementation, it is stated that we could use an explicit 'latest' here. But TBH, I'm not too keen on a setup where we are not in control so without us changing anything, things already merged might start getting flagged in new PRs as linting errors.

Also looking at other projects, most of them seem to lock the version explicitly to one of their choice, which they then keep gradually updating. If we really wanted to go with an uncontrolled rolling version, then we'd need to add a nightly run, to catch extra-repo (IOW golangci-lint) changes breaking things for us...

[bart0sh]

I agree with @klihub here. To have a reproducible builds (tests in this case) we need to lock lint version.

[elezar]

I think this looks good @klihub.

One thought is that for cases where we do record but ignore the errors, we should update the public API documentation to indiate that GetErrors() can be queried to return errors that were raised when refreshing the cache.

Out of scope: we could also look at further segmenting the API to functions that are used by our container runtime consumers (basically Cache instantiation and InjectDevices) so that we have more flexibility with other utility functions such as getting lists of devices.

[klihub]

I think this looks good @klihub.

One thought is that for cases where we do record but ignore the errors, we should update the public API documentation to indiate that GetErrors() can be queried to return errors that were raised when refreshing the cache.

@elezar I updated the doc strings of the relevant Cache public API functions, with a brief mention a possible implicit cache refresh and how to obtain any errors encountered it. PTAL.

[bart0sh]

/lgtm