Lint common error wrapping issues, update README #1969
Merged
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
anmaxvl
approved these changes
Nov 17, 2023
Enable `errorlint` to catch common issues with wrapping and testing for errors. Wherever possible, switched to using `errors.Is` and `errors.As`. Exceptions: - function is defined in the same package and explicitly returns a know error variable - returns from functions in `io`, `binary`, `context`, `syscall`, `golang.org/x/sys/windows`, or `golang.org/x/sys/unix` that are (relatively) stable in error return value and type - conversion would interact with with `github.com/pkg/errors` - conversion would be non-trivial and require additional testing/validation - specifically, legacy code in `runhcs` and the root of the repo Rename `context` to `ctx` in `pkg\go-runhcs\*.go` to avoid overshadowing `context` package. Update `README.md`: - run markdown formatter (spaces around code blocks and headers, raw link URLS) - add section on linter and go generate (similar to go-winio's) Signed-off-by: Hamza El-Saawy <hamzaelsaawy@microsoft.com>
katiewasnothere
approved these changes
Dec 8, 2023
Signed-off-by: Hamza El-Saawy <hamzaelsaawy@microsoft.com>
katiewasnothere
approved these changes
Dec 11, 2023
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.
Enable
errorlintto catch common issues with wrapping and testing for errors.Wherever possible, switched to using
errors.Isanderrors.As. Exceptions:io,binary,context,syscall,golang.org/x/sys/windows, orgolang.org/x/sys/unixthat are (relatively) stable in error return value and typegithub.com/pkg/errorsrunhcsand the root of the repoRename
contexttoctxinpkg\go-runhcs\*.goto avoid overshadowingcontextpackage.Update
README.md: