Support reviewdog command line argument changes (--fail-level) #72
Conversation
This file contains 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
nayuta
changed the title
nayuta
changed the title
nayuta
force-pushed
the
support_reviewdog_parameter_changes
branch
from
a324957 to
091455a
Compare
shmokmt
reviewed
Dec 23, 2024
Co-authored-by: Shoma Okamoto <[email protected]>
Co-authored-by: Shoma Okamoto <[email protected]>
shmokmt
reviewed
Dec 25, 2024
Comment on lines
+93
to
+95
| Optional. The level of failures that will cause the action to fail [any,info,warning,error]. | ||
|
|
||
| The default is `error`. |
There was a problem hiding this comment.
Description hasn't been fixed yet. Please fix 🙏
It might be better to use the same sentence as in action-rubocop.
Suggested change
| Optional. The level of failures that will cause the action to fail [any,info,warning,error]. | |
| The default is `error`. | |
| Optional. If set to none, always use exit code 0 for reviewdog. Otherwise, exit code 1 for reviewdog if it finds at least 1 issue with severity greater than or equal to the given level. Possible values: [none, any, info, warning, error] Default is none. | |
| The default is `none`. |
ref. https://github.com/reviewdog/action-rubocop?tab=readme-ov-file#inputs
Comment on lines
+102
to
+110
| if [[ -n "${INPUT_FAIL_LEVEL}" ]]; then | ||
| fail_level="--fail-level=${INPUT_FAIL_LEVEL}" | ||
| elif [[ "${INPUT_FAIL_ON_ERROR}" = "true" ]]; then | ||
| # For backward compatibility, default to any if fail-on-error is true | ||
| # Deprecated | ||
| fail_level="--fail-level=any" | ||
| else | ||
| fail_level="" | ||
| fi |
There was a problem hiding this comment.
I don’t think it makes sense for reviewdog users to include conditional branching based on options.
The reviewdog code seems to include code to take care when fail-on-error is true. You can just pass the two options as is and there will be no problem.
func failLevel(opt *option) reviewdog.FailLevel {
if opt.failOnError {
slog.Warn("reviewdog: -fail-on-error is deprecated. Use -fail-level=any, or -fail-level=error for github-[pr-]check reporter instead. See also https://github.com/reviewdog/reviewdog/blob/master/CHANGELOG.md")
if opt.failLevel == reviewdog.FailLevelDefault {
switch opt.reporter {
default:
return reviewdog.FailLevelAny
case "github-check", "github-pr-check":
return reviewdog.FailLevelError
}
}
}
return opt.failLevel
}reviewdog/reviewdog#1854
https://github.com/reviewdog/action-rubocop/blob/master/script.sh#L135-L136
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.
Support reviewdog command line argument changes.
New: support fail-level
Deprecated: fail-on-error
See: #70
See also: https://github.com/reviewdog/reviewdog/blob/master/CHANGELOG.md#rotating_light-deprecation-warnings