乐趣区

关于git:通过Git-Hook关联Tapd和Commit

jiezi

提醒 61
Don’t Use Manual Procedures.
不要应用手工流程

–《程序员修炼之道 – 从小工到专家》

前言

Tapd 提供了 Gitlab 代码关联的性能，咱们能够利用这个性能将代码的提交和 Tapd 中的需要进行关联。

能够通过如下的 commit message 将 commit 与 tapd 的 story/bug/task 进行关联。

# 关联需要
--story=[story id] --user=[username in tapd]
# 关联工作
--task=[task id] --user=[username in tapd]
# 关联缺点
--bug=[bug id] --user=[username in tapd]

比方

git commit -m "add tapd description to README.md --story=1000011" --user="Donespeak"

要输出的内容十分的多，如果每次输出 commit message 的时候都须要做这部分工作，那么太浪费时间了。可能自动化的都自动化。

依据分支名 /commit 信息关联 Tapd

commit-msg

#!/bin/bash

# 该脚本会依据分支名称，主动增加绑定 tapd 需要的信息
# 须要提供环境变量 TAPD_USERNAME 以填充 user 信息

# 分支名  | 绑定 TAPD
# --- | ---
# tapd-S1234  | story 1234
# tapd-B1234  | bug 1234
# tapd-T1234   | task 1234

COMMIT_MSG_FILE=$1

BRANCH_PREFIX="tapd-"
BRANCH_REX="$BRANCH_PREFIX[STB]{1}[0-9]+(-.*)?"
TAPD_REFER_REX="--(story|task|bug)=[0-9]+[ ]+--user="
TAPD_REFER_MSG_REX=".*$TAPD_REFER_REX.*"

findTypeIdFromBranch() {local BRANCH=$(git branch | grep '*' | sed 's/* //')
  if [[! "$BRANCH" =~ $BRANCH_REX]]; then
    return 1
  fi
  local TYPE_ID=$($BRANCH#$BRANCH_PREFIX | grep -Eo '^[SBT]{1}[0-9]+')
  findTypeId $TYPE_ID
}

findTypeIdFromMsg() {
  local MSG=$1
  local TYPE_ID=$(echo $MSG | grep -Eo "^#[SBT]{1}[0-9]+" | tr -d '#')
  echo $TYPE_ID
  if [-z $TYPE_ID]; then
    return 1
  fi

  findTypeId $TYPE_ID
}

findTypeId() {
  local TYPE_ID=$1
  if [${#TYPE_ID} -lt 1 ]; then
    return 1
  fi

  TYPE_CHAR=$(echo ${TYPE_ID: 0: 1})
  ID=$(echo ${TYPE_ID: 1})

  case "$TYPE_CHAR" in
    S) TYPE="story"
    ;;
    T) TYPE="task"
    ;;
    B) TYPE="bug"
    ;;
    *)
      return 1
    ;;
  esac
}

ORIGIN_COMMIT_MSG=$(cat $COMMIT_MSG_FILE)
COMMIT_MSG=$ORIGIN_COMMIT_MSG

# --- 如果曾经增加关联，则不做解决 ---
if [[$COMMIT_MSG =~ $TAPD_REFER_MSG_REX]]; then
  exit 0
fi

findTypeIdFromMsg $COMMIT_MSG
FAIL=$?

if [$FAIL -eq 1]; then
  findTypeIdFromBranch
  FAIL=$?
fi

if [$FAIL -eq 1]; then
  echo "WARN: The format of branch name and commit message is incorrect."
  echo "The format of branch should be ${BRANCH_PREFIX}[STB]<tapdId> (example: ${BRANCH_PREFIX}S12345);"
  echo "Or the commit message should start with #[STB]<tapdId> (example: #S12345, message)."
  # 格局不合乎，停止提交
  exit 0
fi

# --- 判断必要环境变量 ---

if [-z $TAPD_USERNAME]; then
  echo "WARN: environment value TAPD_USERNAME is required."
  echo "You can config with the following commands. (Replace [yourname] with your name in Tapd. Using .zshrc instead of .bash_profile if zsh)"
  printf "\n\t%s\n\t%s\n\n" "echo -e'\nexport TAPD_USERNAME=\"[yourname]\"' >> ~/.bash_profile""source ~/.bash_profile"
  exit 0
fi

# --- 减少 TAPD 关联 ---

echo "$COMMIT_MSG" > "$COMMIT_MSG_FILE"
echo -e "\n\n--$TYPE=$ID --user=$TAPD_USERNAME" >> "$COMMIT_MSG_FILE"

环境变量配置

如下命令只有执行一次。

Bash

# 其中的 Bees360 替换为在 Tapd 平台的用户名
echo -e '\nexport TAPD_USERNAME="Bees360"' >> ~/.bash_profile
source ~/.bash_profile

Zsh

# 其中的 Bees360 替换为在 Tapd 平台的用户名
echo -e '\nexport TAPD_USERNAME="Bees360"' >> ~/.zshrc
source ~/.zshrc

执行样例

branch 含有 tapd id

git checkout tapd-S1234
# 缺省 Tapd Id
git commit -m "add more detail to README.md"

生成如下 commit message：

add more detail to README.md

--story=1234 --user=Bees360

message 中提供 tapd id

git commit -m "#S1234, add more detail to README.md"

生成如下 commit message：

#S1234, add more detail to README.md

--story=1234 --user=Bees360

主动增加 commit 对立前缀

在提交的 message 中，我比拟喜爱在 message 的结尾减少关联的需要编号，这样在查看 commit 的时候能够高深莫测看到 commit 属于哪个需要的。

prepare-commit-msg

#!/bin/bash

# 该脚本会依据分支名称，主动增加绑定 tapd 需要 id 前缀

# 分支名  | commit 格局 
# --- | --- 
# tapd-S1234  | #S1234, message
# tapd-B1234  | #B1234, message
# tapd-T1234  | #T1234, message

COMMIT_MSG_FILE=$1

BRANCH_PREFIX="tapd-"
BRANCH_REX="$BRANCH_PREFIX[STB]{1}[0-9]+(-.*)?"
TAPD_MSG_PREFIX_REX="#[STB]{1}[0-9]+(-.*)?"

findTypeIdFromBranch() {local BRANCH=$(git branch | grep '*' | sed 's/* //')
  if [[! "$BRANCH" =~ $BRANCH_REX]]; then
    return 1
  fi
  local TYPE_ID=$(echo $BRANCH | tr -d $BRANCH_PREFIX | grep -Eo '^[SBT]{1}[0-9]+')
  findTypeId $TYPE_ID
}

findTypeId() {
  local TYPE_ID=$1
  if [${#TYPE_ID} -lt 1 ]; then
    return 1
  fi

  TYPE_CHAR=$(echo ${TYPE_ID: 0: 1})
  ID=$(echo ${TYPE_ID: 1})

  case "$TYPE_CHAR" in
    S) TYPE="story"
    ;;
    T) TYPE="task"
    ;;
    B) TYPE="bug"
    ;;
    *)
      return 1
    ;;
  esac
}

ORIGIN_COMMIT_MSG=$(cat $COMMIT_MSG_FILE)
COMMIT_MSG=$ORIGIN_COMMIT_MSG

# --- 如果曾经增加前缀，则不做解决 ---
if [[$COMMIT_MSG =~ $TAPD_MSG_PREFIX_REX.*]]; then
  exit 0
fi

findTypeIdFromBranch
FAIL=$?

if [$FAIL -eq 1]; then
    exit 0
fi

# --- 减少前缀 ----

COMMIT_MSG="#$TYPE_CHAR$ID, $COMMIT_MSG"

echo "$COMMIT_MSG" > "$COMMIT_MSG_FILE"

执行样例

branch 含有 tapd id

git checkout tapd-S1234
# 缺省 Tapd Id
git commit -m "add more detail to README.md"

生成如下 commit message：

#1234, add more detail to README.md

message 中提供 tapd id

git checkout tapd-S1234
git commit -m "#S100012, add more detail to README.md"

生成如下 commit message：

#S100012, add more detail to README.md

主动增加 commit 对立前缀 – 关联 Gitlab Issue

和下面的代码差不多，只是做了一点点批改。

#!/bin/bash

# 分支名  | commit 格局 
# --- | --- 
# issue-1234  | #1234, message

COMMIT_MSG_FILE=$1

BRANCH_PREFIX="issue-"
BRANCH_REX="$BRANCH_PREFIX{1}[0-9]+(-.*)?"
TAPD_MSG_PREFIX_REX="#{1}[0-9]+(-.*)?"

findIssueIdFromBranch() {local BRANCH=$(git branch | grep '*' | sed 's/* //')
  if [[! "$BRANCH" =~ $BRANCH_REX]]; then
    return 1
  fi
  ISSUE_ID=$(echo $BRANCH | tr -d $BRANCH_PREFIX | grep -Eo '^[0-9]+')
}

ORIGIN_COMMIT_MSG=$(cat $COMMIT_MSG_FILE)
COMMIT_MSG=$ORIGIN_COMMIT_MSG

# --- 如果曾经增加前缀，则不做解决 ---
if [[$COMMIT_MSG =~ $TAPD_MSG_PREFIX_REX.*]]; then
  exit 0
fi

findIssueIdFromBranch
FAIL=$?

if [$FAIL -eq 1]; then
    echo "WARN: The branch name format shoud be ${BRANCH_PREFIX}<issue number>, example ${BRANCH_PREFIX}100011"
    # 强制格局，则能够 `exit 1` 以执行失败
    exit 0
fi

# --- 减少前缀 ----

COMMIT_MSG="#$ISSUE_ID, $COMMIT_MSG"

echo "$COMMIT_MSG" > "$COMMIT_MSG_FILE"

Makefile 实现 make 指令装置

将以上的文件增加到 git 我的项目根目录的 git-hooks 目录下，并增加如下 Makefile 文件。

Makefile

install-git-hooks: .git/hooks/prepare-commit-msg  .git/hooks/commit-msg  .git/hooks/pre-push

.git/hooks/%: git-hooks/%
    ln -s $(PWD)/$< $(PWD)/$@

通过如下指令能够实现 githook 的主动关联。

make install-git-hooks

参考

  • 本文章源码 DoneSpeak/Gromithooks
  • Gitlab 集成 @tapd.cn
  • 8.3 自定义 Git – Git 钩子 @git-scm
  • Prepare Commit Message using Git Hook | Create a Git hook prepare-commit-msg for inferring JIRA ticket as commit message prefix, based on the branch name.
退出移动版