Add PR checks for test, lint, and format#7
Merged
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
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.
This pull request introduces several improvements focused on code safety, resource management, and developer tooling. The most significant changes are the addition of GitHub Actions workflows for CI checks, stricter error handling and resource cleanup, and enhanced static analysis and linting. These updates help ensure code reliability, maintainability, and adherence to Go best practices.
CI/CD and Developer Tooling:
.github/workflows/pr-checks.yml) to automatically check Go formatting, run tests, and perform linting on pull requests tomain. This helps catch issues early in the development process..golangci.ymlconfiguration to enable and configure a strict set of linters, improving code quality and consistency.Resource Management and Error Handling:
Close()) with error-checked or ignored closures (e.g.,_ = rdr.Close(), or usingdefer func() { _ = f.Close() }()) across multiple files, ensuring potential errors are handled or intentionally ignored as appropriate. [1] [2] [3] [4] [5] [6] [7] [8] [9]%wfor error wrapping, checking errors witherrors.Is, and consistent error returns. [1] [2]Security and Code Quality:
//nolint:gosecannotations with justifications at specific lines to document intentional exceptions to security linter warnings. [1] [2] [3] [4] [5] [6] [7] [8]CLI Output Consistency:
internal/cli/explain.goto use helper functions (stdoutf,stdoutln) instead of directfmtcalls, improving output handling and testability. [1] [2] [3]These changes collectively improve the robustness, maintainability, and developer experience of the project.