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

fix(simapp/v2): add binary version cmd #22705

Merged
merged 1 commit into from
Dec 2, 2024
Merged

Conversation

mmsqe
Copy link
Contributor

@mmsqe mmsqe commented Dec 2, 2024

avoid unknown command "version" in TestQueryNodeInfo

Description

Closes: #XXXX


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title, you can find examples of the prefixes below:
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • New Features

    • Introduced a new command to access version information directly through the command-line interface.
    • Enhanced build configurability with a dynamic application name based on build options.
  • Bug Fixes

    • Updated linker flags to reflect changes in application naming conventions.

avoid unknown command "version" in TestQueryNodeInfo
Copy link
Contributor

coderabbitai bot commented Dec 2, 2024

📝 Walkthrough

Walkthrough

The changes in this pull request primarily involve modifications to the build.mk file, which now includes a new variable APPNAME for dynamic application naming based on build options. Additionally, a new command for retrieving version information is introduced in the CLI through the commands.go file. These updates enhance the configurability of the build process and expand the command-line interface capabilities without altering the fundamental flow or error handling.

Changes

File Change Summary
scripts/build/build.mk - Added variable APPNAME = simd.
- Updated APPNAME to simdv2 when COSMOS_BUILD_OPTIONS contains v2.
- Replaced hardcoded app name in linker flags with $(APPNAME).
- Adjusted build tags based on COSMOS_BUILD_OPTIONS.
simapp/v2/simdv2/cmd/commands.go - Added import statement for github.com/cosmos/cosmos-sdk/version.
- Introduced version.NewVersionCommand() in the InitRootCmd function.

Possibly related PRs

Suggested labels

C:CLI, C:x/upgrade

Suggested reviewers

  • julienrbrt
  • facundomedica
  • tac0turtle

📜 Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 40430fe and 74e1166.

📒 Files selected for processing (2)
  • scripts/build/build.mk (3 hunks)
  • simapp/v2/simdv2/cmd/commands.go (2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
simapp/v2/simdv2/cmd/commands.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

🔇 Additional comments (5)
scripts/build/build.mk (3)

10-10: LGTM: Clean variable declaration

The APPNAME variable is properly declared with a default value of 'simd'.


56-57: LGTM: Conditional APPNAME update

The APPNAME is correctly updated to 'simdv2' when v2 build option is present, maintaining consistency with the v2 module structure.


91-91: LGTM: Dynamic version information in ldflags

The ldflags now correctly use the dynamic $(APPNAME) variable instead of a hardcoded value, which properly supports the version command functionality.

simapp/v2/simdv2/cmd/commands.go (2)

29-29: LGTM: Clean import addition

The version package import is properly added.


69-69: LGTM: Version command integration

The version command is correctly added to the root command, addressing the "unknown command 'version'" error.

This change, combined with the dynamic APPNAME in build.mk, provides proper version information in the CLI.


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 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.

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.

Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

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

Thanks! utACK

@julienrbrt julienrbrt added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Dec 2, 2024
@julienrbrt julienrbrt added this pull request to the merge queue Dec 2, 2024
Merged via the queue into cosmos:main with commit c207a45 Dec 2, 2024
70 of 80 checks passed
mergify bot pushed a commit that referenced this pull request Dec 2, 2024
@julienrbrt
Copy link
Member

Eventually, we should improve the version command to display the CometBFT Server and all the server/v2 components directly without having to pass --long. It should change nothing if you use baseapp.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants