CowDogMoo / warpgate

35%

main: 35%

LAST BUILD ON BRANCH refactor/idiomatic-go-doc-comments

branch: refactor/idiomatic-go-doc-comments

CHANGE BRANCH

x

Reset

Sync Branches

• refactor/idiomatic-go-doc-comments
• gh-readonly-queue/main/pr-1679-9d43560965342d53d7a1449a88aace994ec60415
• gh-readonly-queue/main/pr-1680-a603fccdcec090d3a1d0336cc136b08f3d8d47b6
• gh-readonly-queue/main/pr-1681-d231b43413893c0636712a67e5b1737c9db49677
• gh-readonly-queue/main/pr-1682-7ecc4146dbe02648b3cb67c5782f1601cd9581cf
• main
• renovate/aws-sdk-go-v2-monorepo
• renovate/github.com-moby-buildkit-0.x
• renovate/go-indirect-dependencies
• renovate/renovatebot-github-action-44.x

Build # 21620048232

Build Type

Pull #1683

github

Committed by l50

Commit Message

refactor: improve documentation, config logic, and error handling across CLI and templates

**Added:**

- Introduced `cmd/warpgate/root_test.go` with comprehensive tests for root command configuration, flag binding, viper overrides, help/version/error output, and required flag enforcement
- Added new tests to `templates/registry_test.go` for unknown and local repositories in template registry

**Changed:**

- Rewrote and clarified function comments for constructors and key methods across `cli`, `cmd/warpgate`, `config`, and `templates` packages to use GoDoc best practices and cross-references
- Improved and clarified documentation for CLI commands, template loader/validator, registry listing, and scaffolder operations
- Refined `root.go` config precedence logic for clarity, removed redundant comments, and improved environment variable binding
- Added `ApplyViperOverrides` function to push Viper/env/config values into unset CLI flags, ensuring correct precedence
- Updated `main.go` to handle context cancellation and signals for graceful shutdown
- Refined help/version output in `version.go` to use Cobra's output for better integration
- Improved documentation and usage comments in `buildkit.go`, `output.go`, and related files for clarity
- Updated Go version to 1.25.6 in `go.mod`

**Removed:**

- Stripped redundant, verbose, or outdated comments in favor of precise, GoDoc-style summaries across multiple files
- Removed excessive sectioning and placeholder comments in flag registration in `manifests.go` for brevity and clarity

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%)

3947 of 11240 relevant lines covered (35.12%)

8.02 hits per line