docs(contributing): avoid editor prompt when tagging releases - #76
Open
nicomiguelino wants to merge 1 commit into
Open
docs(contributing): avoid editor prompt when tagging releases#76nicomiguelino wants to merge 1 commit into
nicomiguelino wants to merge 1 commit into
Conversation
Use 'git tag -a vX.Y.Z -m "vX.Y.Z"' instead of a bare annotated tag, since git tag -a always opens an editor unless -m or -F is given.
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the release instructions for maintainers to ensure tags are created as annotated tags without triggering an interactive editor prompt, aligning the documented process with the repository’s release workflow expectations.
Changes:
- Replace the bare
git tag vX.Y.Zexample with an annotated tag command. - Add
-m "vX.Y.Z"to avoid opening an editor when creating the annotated tag.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
CONTRIBUTING.mdused a baregit tag vX.Y.Z, but the actual release command needs to be an annotated tag (git tag -a) to carry a message.git tag -aalways opens an editor unless-m/-Fis passed (confirmed in the git-tag docs), so the docs now showgit tag -a vX.Y.Z -m "vX.Y.Z"to avoid that prompt.Test plan