Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(main): Add version flag to display application version #45

Merged
merged 2 commits into from
Feb 2, 2025

Conversation

mertssmnoglu
Copy link
Member

@mertssmnoglu mertssmnoglu commented Feb 1, 2025

Description of Changes

  • Added the flag package to handle command-line flags and a new Version variable to store the application's version.
  • Implemented a version flag (-version) that, when used, prints the application's version and exits.

Configuration initialization refactor:

  • Changed the appConfig variable from a direct initialization to a pointer and moved its initialization inside the main function.

Issue Number

#41

Summary by CodeRabbit

  • New Features

    • Introduced a command-line option that displays the application’s version, allowing users to easily identify the current build.
  • Chores

    • Updated build settings to optimize the executable and reliably embed dynamic version information.

@mertssmnoglu mertssmnoglu added this to the v1.0.1 milestone Feb 1, 2025
@mertssmnoglu mertssmnoglu self-assigned this Feb 1, 2025
Copy link

coderabbitai bot commented Feb 1, 2025

Walkthrough

The pull request updates the build configuration and command-line interface for the capture project. In the .goreleaser.yml file, three new linker flags are added under both the builds and kos sections to optimize the binary by stripping debugging information, enforcing static linking, and dynamically injecting the version. In cmd/capture/main.go, a new command-line flag is introduced to display the application's version, and the configuration initialization is changed to a pointer for flexibility.

Changes

File(s) Change Summary
.goreleaser.yml Added three ldflags for both builds and kos sections: -s -w (omit symbols), -extldflags "-static" (static linking), and -X "main.Version={{.Version}}" (version injection).
cmd/capture/main.go Introduced a new command-line flag (--version) to display the app version and updated the configuration initialization from a value to a pointer for flexible setup.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant M as Main Application
    U->>M: Execute `capture --version`
    M->>M: Parse command-line flags
    alt Version flag is set
       M->>U: Print version info ("capture version: <version>")
       M->>M: Exit application
    else
       M->>M: Initialize config and continue execution
    end
Loading

Possibly related issues

  • Binary version clarification #41: Addresses the requirement for displaying the binary version via a command-line flag, aiding troubleshooting by providing clear version information.

Possibly related PRs

Suggested reviewers

  • ajhollid

Poem

I'm a bunny hopping through the code,
Celebrating changes in version mode.
With linker flags set so neat and sly,
And a flag to show the app's supply,
I leap through builds with a joyful glow! 🐇💻

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Signed-off-by: Mert Şişmanoğlu <mert190737fb@gmail.com>
@mertssmnoglu mertssmnoglu force-pushed the feat/41-binary-version branch from 7ff9cd0 to e9f4be0 Compare February 1, 2025 13:58
- s
- w
- extldflags static
- X main.Version = APP_VERSION

Signed-off-by: Mert Şişmanoğlu <mert190737fb@gmail.com>
@mertssmnoglu mertssmnoglu marked this pull request as ready for review February 1, 2025 14:04
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
cmd/capture/main.go (1)

25-32: Consider using a more standardized version output format.

While the version flag implementation is correct, consider using a more standardized format that includes additional build information. This would be helpful for debugging and support.

-		fmt.Printf("Capture version: %s\n", Version)
+		fmt.Printf("capture %s\n", Version)
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2f8f3f9 and a6a6198.

📒 Files selected for processing (2)
  • .goreleaser.yml (2 hunks)
  • cmd/capture/main.go (2 hunks)
🔇 Additional comments (5)
cmd/capture/main.go (3)

5-6: LGTM!

The new imports are correctly added and necessary for the version flag functionality.


20-20: LGTM!

Good change to make appConfig a pointer, allowing for better initialization control.


22-22: LGTM!

The Version variable is well-defined with a clear comment explaining its compile-time modification.

.goreleaser.yml (2)

7-10: LGTM!

The ldflags are well-configured for:

  • Optimizing binary size (-s -w)
  • Ensuring static linking
  • Injecting the version information

41-41: LGTM!

The Version variable injection is correctly configured and consistent with the builds section.

@mertssmnoglu mertssmnoglu linked an issue Feb 2, 2025 that may be closed by this pull request
@mertssmnoglu mertssmnoglu merged commit 14aff9e into develop Feb 2, 2025
2 checks passed
@mertssmnoglu mertssmnoglu deleted the feat/41-binary-version branch February 14, 2025 13:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Binary version clarification
1 participant