Skip to content

chore: use --match 'v*' in git describe to ignore submodule tags#2037

Open
jtobin wants to merge 1 commit intolightninglabs:mainfrom
jtobin:ci-tag-fix
Open

chore: use --match 'v*' in git describe to ignore submodule tags#2037
jtobin wants to merge 1 commit intolightninglabs:mainfrom
jtobin:ci-tag-fix

Conversation

@jtobin
Copy link
Copy Markdown
Member

@jtobin jtobin commented Mar 23, 2026

When a commit has both a release tag (e.g. v0.7.0) and a Go submodule tag (e.g. taprpc/v1.0.13), git describe --tags may return the submodule tag, causing 1) the submodule tag to be baked as the version string into any locally-built binary (e.g. taprpc/v1.0.13-445-g4f622253), and 2) the release build to fail with the "tag not checked out" error.

The use of "--match 'v*'" fixes the issue by ensuring that 'git describe' only hits an actual release tag (so we get e.g. v0.7.0-445-g4f622253 instead, and the release build works).

When a commit has both a release tag (e.g. v0.7.2) and a Go submodule
tag (e.g. taprpc/v1.0.13), git describe --tags may return the submodule
tag, causing 1) the submodule tag to be baked as the version string into
any locally-built binary, and 2) the release build to fail with the "tag
not checked out" error.

The use of "--match 'v*'" fixes the issue by ensuring that 'git
describe' only hits an actual release tag.
@gemini-code-assist
Copy link
Copy Markdown

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request addresses an issue where the git describe command could inadvertently select submodule tags instead of the main project's release tags. By introducing the --match 'v*' argument to git describe in both the Makefile and the release.sh script, the changes ensure that version strings are accurately generated based on actual release tags and prevent build failures caused by incorrect tag identification.

Highlights

  • Version String Accuracy: Ensured that git describe correctly identifies release tags by adding --match 'v*', preventing submodule tags from being used in version strings.
  • Release Build Stability: Resolved release build failures that occurred when git describe incorrectly picked up submodule tags, by explicitly matching only 'v'-prefixed release tags.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates git describe commands in the Makefile and scripts/release.sh to include the --match 'v*' flag. This ensures that only release tags, which are prefixed with 'v', are considered for version string generation, thereby ignoring submodule tags. The changes are consistent across both files and effectively address the versioning and release build issues described. I have reviewed the changes and have no further feedback.

@lightninglabs-deploy
Copy link
Copy Markdown

@GeorgeTsagk: review reminder
@jtobin, remember to re-request review from reviewers when ready

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: 🆕 New

Development

Successfully merging this pull request may close these issues.

3 participants