Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cleanup old error names before full v5 release #4033

Closed
spencerschrock opened this issue Apr 15, 2024 · 2 comments · Fixed by #4040
Closed

Cleanup old error names before full v5 release #4033

spencerschrock opened this issue Apr 15, 2024 · 2 comments · Fixed by #4040
Assignees
Labels
Milestone

Comments

@spencerschrock
Copy link
Contributor

We have a few linter exceptions around old errors which don't follow the naming conventions enabled in #3587.

It would be good to take care of the //nolint:errname directives while we're doing breaking changes.

ErrorUnsupportedHost = errors.New("unsupported host") //nolint:errname
// ErrorInvalidURL indicates the repo's full URL was not passed.
ErrorInvalidURL = errors.New("invalid repo flag") //nolint:errname
// ErrorShellParsing indicates there was an error when parsing shell code.
ErrorShellParsing = errors.New("error parsing shell code") //nolint:errname
// ErrJobOSParsing indicates there was an error when detecting a job's operating system.
ErrJobOSParsing = errors.New("error parsing job operating system")
// ErrorUnsupportedCheck indicates check cannot be run for given request.
ErrorUnsupportedCheck = errors.New("check is not supported for this request") //nolint:errname
// ErrorCheckRuntime indicates an individual check had a runtime error.
ErrorCheckRuntime = errors.New("check runtime error") //nolint:errname

var (
// some of these errors didn't follow naming conventions when they were introduced.
// for backward compatibility reasons, they can't be changed and have nolint directives.
// ErrorEmptyConfigValue indicates the value for the configuration option was empty.
ErrorEmptyConfigValue = errors.New("config value set to empty") //nolint:errname
// ErrorValueConversion indicates an unexpected type was found for the value of the config option.
ErrorValueConversion = errors.New("unexpected type, cannot convert value") //nolint:errname
// ErrorNoConfig indicates no config file was provided, or flag.Parse() was not called.
ErrorNoConfig = errors.New("no configuration file provided with --" + configFlag) //nolint:errname

@spencerschrock spencerschrock added this to the v5 milestone Apr 15, 2024
@cmwylie19
Copy link
Contributor

cmwylie19 commented Apr 15, 2024

can you please assign this to me? (i'm at SOSS day at OpenSSF)

@laurentsimon
Copy link
Contributor

@cmwylie19 the issue is assigned to you. Welcome!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants