如何重命名Git标签

技术背景

在使用Git进行版本控制时，有时需要对已有的标签进行重命名。标签是指向特定提交的引用，分为轻量级标签和附注标签。重命名标签的操作并不复杂，但需要注意一些细节，以确保操作的正确性和安全性。

实现步骤

重命名轻量级标签

1
2
3

git tag new old           # 创建一个名为`new`的本地标签，从标签`old`复制。
git tag -d old            # 删除本地标签`old`。
git push origin new :old  # 将`new`标签推送到名为“origin”的远程仓库，并删除远程仓库上的`old`标签。

为确保其他用户删除已删除的标签，让他们运行以下命令：

1	`git fetch --prune --prune-tags`

重命名附注标签

如果不确定旧标签是否为附注标签，可以使用^{}来解引用对象，直到找到非标签对象：

1 2	`# 创建一个新的附注标签“new”，引用旧附注标签“old”所引用的对象： git tag -a new old^{}`

通用三步法

步骤1：确定当前标签指向的提交/对象ID

1
2
3

command: git rev-parse <tag name>
example: git rev-parse v0.1.0-Demo
example output: db57b63b77a6bae3e725cbb9025d65fa1eabcde

步骤2：从仓库中删除标签

1
2
3

command: git tag -d <tag name>
example: git tag -d v0.1.0-Demo
example output: Deleted tag 'v0.1.0-Demo' (was abcde)

步骤3：创建一个新标签，指向旧标签所指向的相同提交ID

1
2
3

command: git tag -a <tag name>  -m "appropriate message" <commit id>
example: git tag -a v0.1.0-full  -m "renamed from v0.1.0-Demo" db57b63b77a6bae3e725cbb9025d65fa1eabcde
example output: Nothing or basically <No error>

将本地的标签名更改推送到远程仓库：

1
2
3

command: git push origin :<old tag name> <new tag name>
example: git push origin :v0.1.0-Demo v0.1.0-full
example output: <deleted & new tags>

一键重命名别名法

在.gitconfig中添加别名：

1 2	`[alias] renameTag = "!sh -c 'set -e;git tag $2 $1; git tag -d $1;git push origin :refs/tags/$1;git push --tags' -"`

使用方法：

1	`git renametag old new`

复制并删除法（适用于附注标签）

1 2	git tag -a -m "`git cat-file -p old_tag \| tail -n +6`" new_tag old_tag^{} git tag -d old_tag

为避免同步问题，建议先推送新标签，再删除旧标签：

git tag -a -m "`git cat-file -p old_tag | tail -n +6`" new_tag old_tag^{}
git push --tags
git tag -d old_tag
git push origin :refs/tags/old_tag

远程标签/分支重命名

远程标签重命名/远程分支 → 标签转换

1	`git push <remote_name> <old_branch_or_tag>:refs/tags/<new_tag> :<old_branch_or_tag>`

远程分支重命名/远程标签 → 分支转换

1	`git push <remote_name> <old_branch_or_tag>:refs/heads/<new_branch> :<old_branch_or_tag>`

核心代码

以下是一个重命名标签并保留大部分数据的脚本：

#!/usr/bin/env bash

# 重命名Git标签并保留大部分数据
# 删除旧标签

# 推送新标签，删除旧标签:
# git push origin new_tag :old_tag

# 基于 https://stackoverflow.com/a/65296616/10440128

set -e

function deref() {
  git for-each-ref "refs/tags/$1" --format="%($2)"
}

function git_tag_rename() {
  local tag1="$1"
  local tag2="$2"
  [ -z "$tag1" ] && return 1
  [ -z "$tag2" ] && return 1
  GIT_COMMITTER_NAME="$(deref $tag1 taggername)" \
  GIT_COMMITTER_EMAIL="$(deref $tag1 taggeremail)" \
  GIT_COMMITTER_DATE="$(deref $tag1 taggerdate)" \
  git tag "$tag2" "$(deref $tag1 '*objectname')" -a \
    -m "$(deref $tag1 contents)" &&
  git tag -d "$tag1"
}

if [ -z "$1" ] || [ -z "$2" ]; then
  echo "usage: $0 tag_1 tag_2" >&2
  exit 1
fi

git_tag_rename "$1" "$2"