chore: automate version management #41

satococoa · 2025-11-01T15:38:21Z

Summary

Eliminates the need to manually update version numbers in source code by leveraging existing ldflags injection.

Changes

Set default version to "dev" in cmd/wtp/main.go
Updated comments to clarify version management strategy

How It Works

Release builds: GoReleaser sets version from git tags via -X main.version={{.Version}}
Dev builds: Taskfile sets version from git describe via ldflags
Direct go run: Falls back to "dev"

Benefits

No more manual version updates in code
Version always reflects git state
Prevents version mismatch bugs

Testing

# Without ldflags
go run ./cmd/wtp --version
# Output: wtp version dev

# With Taskfile (uses git describe)
task build && ./wtp --version
# Output: wtp version v2.3.1-dirty

Summary by CodeRabbit

Chores
- Development builds now present a generic "dev" version string and include placeholders for commit/date metadata.
- Documentation updated to explain how version strings are determined for releases vs development builds and that commit/date may be included in future verbose output.
- No changes to application behavior, runtime logic, or error handling.

coderabbitai · 2025-11-01T15:38:47Z

Walkthrough

Version identifier changed from "2.3.1" to "dev"; two unexported variables (commit, date) were added with comments documenting ldflags usage for releases and dev builds. No control-flow or runtime behavior was modified.

Changes

Cohort / File(s)	Summary
Build/version metadata `cmd/wtp/main.go`	Replaced version literal `"2.3.1"` with `"dev"`; added unexported variables `commit = "none"` and `date = "unknown"` with `// nolint:unused` and expanded comments explaining how ldflags populate version/commit/date for releases and dev builds. No functional changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Review cmd/wtp/main.go to confirm comments accurately describe ldflags and defaults.
Verify commit/date declarations and // nolint:unused usage are appropriate and build cleanly.

Poem

🐰 I nibble metadata in a sunny glen,
Version set to "dev", with commit and date penned,
Ldflags hide seeds for when releases spin,
I hop away content — the runtime stays akin,
A quiet patch, soft paws and tidy end.

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run `@coderabbitai generate docstrings` to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The PR title "chore: automate version management" directly and accurately captures the main objective of this changeset. The raw summary confirms that versioning metadata is expanded and the version constant is changed to "dev", while the PR objectives clearly state the purpose is to eliminate manual version updates by using ldflags injection at build time. The title is concise, clear, and specific enough that a teammate reviewing history would immediately understand this PR is about automating the version management process rather than manually updating version strings in code.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch chore/automate-version-management

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8e27cb7 and 9a4a567.

📒 Files selected for processing (1)

cmd/wtp/main.go (1 hunks)

🔇 Additional comments (3)

cmd/wtp/main.go (3)

9-14: Excellent documentation of version management approach.

The multi-line comment clearly explains the three build scenarios and the role of ldflags injection. This provides valuable context for maintainers and aligns well with the PR objectives.

16-16: Appropriate default version value.

The "dev" default is a sensible fallback for builds without ldflags injection (e.g., go run), making it easy to distinguish development builds from released versions.

17-18: Build configuration correctly injects commit and date values—no action needed.

Verification confirms your Taskfile properly sets both variables via ldflags (-X main.commit={{.COMMIT}} -X main.date={{.DATE}}). The variables are intentionally documented as available for future use (e.g., verbose version info), making them reasonable placeholders for planned enhancements rather than dead code. The nolint directives are appropriate.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

Copilot

Pull Request Overview

This PR updates the version information handling in the main entry point to clarify build sources and change the default development version. The changes improve documentation around how version information is populated across different build scenarios (releases, development builds, and direct runs).

Updated version default from "2.3.1" to "dev" to better indicate non-release builds
Enhanced comments to explain version information is set via ldflags from multiple sources (GoReleaser, Taskfile, or defaults)
Clarified that unused commit and date variables are set by ldflags in general, not just GoReleaser

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

coderabbitai

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f859472 and 4491242.

📒 Files selected for processing (1)

cmd/wtp/main.go (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

GitHub Check: E2E Tests (macos-latest)

🔇 Additional comments (1)

cmd/wtp/main.go (1)

9-14: LGTM! Clear documentation and appropriate default.

The updated comments effectively document the version management strategy across different build scenarios, and the "dev" default is appropriate for direct go run invocations without ldflags injection.

cmd/wtp/main.go

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

cmd/wtp/main.go (1)
17-18: Consider removing unused variables or suppressing linter warnings.

The past critical issue with blank identifiers has been successfully resolved. However, the linter correctly reports that commit and date are currently unused. While the comments indicate they're reserved for future verbose output, you have two options:
Remove them until needed (cleaner approach):
var (
	version = "dev"
-	commit  = "none"
-	date    = "unknown"
)
Then add them back when implementing verbose version output.
Suppress the linter warnings if implementing verbose output is planned soon:
var (
	version = "dev"
-	commit  = "none"
-	date    = "unknown"
+	commit  = "none"    //nolint:unused // Reserved for future verbose version output
+	date    = "unknown" //nolint:unused // Reserved for future verbose version output
)

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4491242 and 8e27cb7.

📒 Files selected for processing (1)

cmd/wtp/main.go (1 hunks)

🧰 Additional context used

🪛 GitHub Check: Lint

cmd/wtp/main.go

[failure] 18-18:
var date is unused (unused)

[failure] 17-17:
var commit is unused (unused)

🔇 Additional comments (2)

cmd/wtp/main.go (2)

9-14: LGTM: Clear documentation of version management approach.

The comment block effectively documents the three versioning scenarios (release, dev, and default builds) and clarifies that commit and date are available for future use.

16-16: LGTM: Version default aligns with PR objectives.

Setting the default to "dev" is the correct approach for builds without ldflags injection.

- Version is automatically set via ldflags in both dev and release builds - GoReleaser sets version from git tags in releases - Taskfile sets version from git describe in dev builds - Eliminates manual version updates in source code

Copilot AI review requested due to automatic review settings November 1, 2025 15:38

Copilot AI reviewed Nov 1, 2025

View reviewed changes

coderabbitai bot reviewed Nov 1, 2025

View reviewed changes

cmd/wtp/main.go Outdated Show resolved Hide resolved

satococoa force-pushed the chore/automate-version-management branch from 4491242 to 8e27cb7 Compare November 1, 2025 15:49

coderabbitai bot reviewed Nov 1, 2025

View reviewed changes

chore: use 'dev' as default version in source

9a4a567

- Version is automatically set via ldflags in both dev and release builds - GoReleaser sets version from git tags in releases - Taskfile sets version from git describe in dev builds - Eliminates manual version updates in source code

satococoa force-pushed the chore/automate-version-management branch from 8e27cb7 to 9a4a567 Compare November 1, 2025 16:17

satococoa merged commit 3e11704 into main Nov 4, 2025
7 checks passed

satococoa deleted the chore/automate-version-management branch November 4, 2025 13:51

coderabbitai bot mentioned this pull request Nov 5, 2025

fix: show module version for go install builds #44

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

chore: automate version management #41

chore: automate version management #41

Uh oh!

satococoa commented Nov 1, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Nov 1, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

chore: automate version management #41

chore: automate version management #41

Uh oh!

Conversation

satococoa commented Nov 1, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes

How It Works

Benefits

Testing

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Nov 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Poem

Pre-merge checks and finishing touches

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

satococoa commented Nov 1, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Nov 1, 2025 •

edited

Loading