CowDogMoo / warpgate / 21619626266

35%

main: 35%

Build Type

Pull #1683

github

Committed by l50

Commit Message

refactor: improve doc comments and context handling across cli and core packages

**Added:**

- Added `cmd/warpgate/root_test.go` with comprehensive unit tests for Cobra/Viper integration, CLI flag handling, context propagation, and root/version command behaviors

**Changed:**

- Rewrote or clarified doc comments for constructor functions (e.g., `NewParser`, `NewValidator`, `NewLoader`, `NewGitOperations`, `NewPathValidator`) to use Go style and reference returned concrete types
- Improved doc comments throughout CLI packages to clarify function behavior, especially for constructors and public APIs
- Enhanced signal and context management in `cmd/warpgate/main.go` by wiring SIGINT/SIGTERM to command execution context and ensuring cleanup
- Updated `cmd/warpgate/manifests.go` to invoke parent's `PersistentPreRunE` hook for consistent initialization and removed redundant flag commentaries
- Refined comment and docstring style in `cmd/warpgate/root.go`; removed stepwise commentary, clarified Viper/flag precedence logic, adjusted help output, and documented `ApplyViperOverrides`
- Changed version output in `cmd/warpgate/version.go` to use `cmd.Printf` for consistent output stream handling
- Updated doc comments in template and manifest core packages for constructors and key public methods, using bracketed type references and clarifying method effects
- Clarified Go version in `go.mod` from 1.25.5 to 1.25.6

**Removed:**

- Removed superfluous inline commentary, redundant step-by-step code comments, and transitional notes in favor of canonical Go doc comments across multiple files
- Eliminated unnecessary TODO-style comments in `manifests/registry.go` and `builder/ami/imagebuilder.go` regarding manifest idempotency and versioning logic

Pull Request Pull Request #1683: refactor: improve code documentation and CLI env override logic

Run Details

25 of 36 new or added lines in 4 files covered. (69.44%)

1 existing line in 1 file now uncovered.

3906 of 11240 relevant lines covered (34.75%)

8.02 hits per line