Fix API version shown in build details

[m-Peter]

Closes: #730

Description

There was a regression with the latest changes on the Makefile, which ended up showing the commit tag in the build version:

{"level":"info","version":"a4ce4cc","time":"2025-01-23T12:56:18+01:00","message":"build details"}

instead of the proper tag version, e.g. v1.0.1.
This is also used in the web3_clientVersion JSON-RPC endpoint, and is useful for viewing which version is run by a given EVM Gateway instance.

---

For contributor use:

• Targeted PR against master branch
• Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
• Code follows the standards mentioned here.
• Updated relevant documentation
• Re-reviewed Files changed in the Github PR explorer
• Added appropriate labels

Summary by CodeRabbit

• Chores
  • Updated version retrieval method in build process
  • Modified how version is embedded in the binary
  • Changed Git tag version extraction to use most recent tag without additional commit details

[coderabbitai]

Walkthrough

The pull request modifies the Makefile to improve version retrieval during the build process. The key change involves adjusting the Git version command to use --abbrev=0, which ensures that the version string reflects the most recent tag without additional commit information. Additionally, the build command now uses $(GIT_VERSION) instead of $(IMAGE_TAG) when setting the version flag for the binary, addressing inconsistencies in version reporting.

Changes

File	Change Summary
Makefile	- Modified GIT_VERSION command from --abbrev=2 to --abbrev=0 - Updated build command to use $(GIT_VERSION) instead of $(IMAGE_TAG) for version flag

Assessment against linked issues

Objective	Addressed	Explanation
Fix version number inconsistency [#730]	✅

Possibly related PRs

• Return the released version in web3_clientVersion #328: Modifies Docker build command to include dynamically retrieved version
• Use the released tag version to identify newly-created docker images #592: Focuses on versioning system based on Git tags

Suggested labels

Improvement, EVM

Suggested reviewers

• peterargue
• sideninja
• zhangchiqing

Poem

🐰 A version tale, oh so bright,
Tags now shine with pure delight
No more hash, no more strife
Git version leaps to new life!
Precision tagged, our code takes flight 🚀

---

📜 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 56428e2 and c12d564.

📒 Files selected for processing (1)

• Makefile (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: Lint
• GitHub Check: Test

🔇 Additional comments (2)

Makefile (2)

7-7: LGTM! Verify tag retrieval behavior.

The change to use --abbrev=0 correctly ensures that only the clean version tag (e.g., v1.0.1) is used, without any commit hash information.

Let's verify the tag retrieval behavior:

✅ Verification successful

✓ Tag retrieval behavior verified successfully

The repository uses proper semantic version tags (e.g., v1.0.1), and git describe --tags --abbrev=0 will correctly return clean version tags without commit hash information, which aligns perfectly with the PR's objective to fix the version display format.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that GIT_VERSION retrieves clean version tags.

# Test 1: Check current tag format
git describe --tags --abbrev=0 2>/dev/null

# Test 2: List all tags to verify format consistency
git tag -l

Length of output: 45

---

Script:

#!/bin/bash
# Description: Diagnostic checks for git and repository state

# Check if we're in a git repository
echo "=== Git Status ==="
git status

# Verify git version
echo -e "\n=== Git Version ==="
git --version

# Check for any refs
echo -e "\n=== Git Refs ==="
git show-ref

# List remote tags
echo -e "\n=== Remote Tags ==="
git ls-remote --tags origin

Length of output: 7519

---

89-89: LGTM! Verify version flag setting.

Using $(GIT_VERSION) instead of $(IMAGE_TAG) correctly ensures that the web3_clientVersion JSON-RPC endpoint shows the proper version tag.

Let's verify the version flag behavior:

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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