📖 re-enable golangci-lint's godoc comment checking #885
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
k8s-ci-robot
added
cncf-cla: yes
|
/assign @mengqiy |
alvaroaleman
reviewed
Apr 5, 2020
.github/main.workflow
Outdated
| resolves = ["lint"] | ||
| } | ||
|
|
||
| action "lint" { |
There was a problem hiding this comment.
Why is this done via github actions and not via a prow presubmit like the other tests?
There was a problem hiding this comment.
It is called by the prow already. See that if it is missing some comment the test will fail.
Example:
level=info msg="[runner] linters took 9.994443697s with stages: goanalysis_metalinter: 9.9921147s"
pkg/internal/testing/integration/internal/etcd.go:7:1: comment on exported var `EtcdDefaultArgs` should be of the form `EtcdDefaultArgs ...` (golint)
//todo(just to ensure that the pr will fails and the test is called in the prow): EtcdDefaultArgs allow tests to run offline, by preventing API server from attempting to
Test executed just to ensure that it will fail.
k8s-ci-robot
added
the
lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: camilamacedo86, vincepri The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Now, the lint test will be checking the comments for the go-docs and then, it is called in the checks made in prow to allow or not merge the PR.
Also, in this PR, we have the fix for the places where the comments were missing.
Motivation
Closes: #501