ci: enable checks for missing Go documentation

Checks for missing Go documentation used to be covered by the now
defunct project `golint`. Revive is a replacement for golint that is
used by `golangci-lint`. However, `golangci-lint` disables checks for
missing Go documentation by default[0]. The only way to re-enable them
is apparently to suppress golangci-lint's default rules, which is what
this commit does. Rules that triggered false-positive on this codebase
have been manually added. The list of default exclude rules can be found
by running `golangci-lint run --help`.

[0]: golangci/golangci-lint#456

Signed-off-by: Robin Hahling <[email protected]>

Author: rolinh

.golangci.yml

@@ -34,6 +34,13 @@ linters-settings:
     go: "1.16"
 
 issues:
+  # Default rules exclude Go doc comments check, which is rather unfortunate.
+  # In order to enable Go doc checks, defaults rules have to be disabled.
+  # See https://github.com/golangci/golangci-lint/issues/456 for details.
+  exclude-use-default: false
+  exclude:
+    - (G104|G307) # EXC0008 gosec: Duplicated errcheck checks
+
   exclude-rules:
     - linters: [staticcheck]
       text: "SA1019" # deprecated methods