chore(触发构建): 触发构建

feat(all): add support for signing commit (#2)

.drone.yml

@@ -1,10 +1,28 @@
 kind: pipeline
 type: docker
 name: default
-
+node:
+  region: cn
 steps:
+  - name: generate
+    pull: if-not-exists
+    image: ccr.ccs.tencentyun.com/xiaoqidun/build
+    commands:
+      - build -f build.sh -i gitcz.go -o release/gitcz
   - name: build
     pull: if-not-exists
-    image: golang:alpine
+    image: ccr.ccs.tencentyun.com/xiaoqidun/goenv
     commands:
-      - go build gitcz.go
+      - ./build.sh
+  - name: upload
+    image: ccr.ccs.tencentyun.com/xiaoqidun/gocos
+    settings:
+      secret_id:
+        from_secret: cos_secret_id
+      secret_key:
+        from_secret: cos_secret_key
+      bucket_url:
+        from_secret: cos_bucket_url
+      source: release/
+      target: product/gitcz
+      strip_prefix: release/

README.md

@@ -1,26 +1,38 @@
 # gitcz
-Golang版本Git Commitizen，commit规范工具
+
+Golang 版本 Git Commitizen，commit 规范工具
+
 # 快速安装
-go get -u github.com/xiaoqidun/gitcz
+
+go install github.com/xiaoqidun/gitcz@latest
+
 # 编译安装
+
 ```
 git clone https://github.com/xiaoqidun/gitcz.git
 cd gitcz
 go build gitcz.go
 ```
+
 # 手动安装
-1. 根据系统架构下载为你编译好的[二进制文件](https://github.com/xiaoqidun/gitcz/releases)
+
-2. 将下载好的二进制文件重命名为gitcz并保留后缀
+1. 根据系统架构下载为你编译好的[二进制文件](https://aite.xyz/product/gitcz/)
-3. 把gitcz文件移动到系统PATH环境变量中的目录下
+2. 将下载好的二进制文件重命名为 gitcz 并保留后缀
-4. windows外的系统需使用chmod命令赋予可执行权限
+3. 把 gitcz 文件移动到系统 PATH 环境变量中的目录下
+4. windows 外的系统需使用 chmod 命令赋予可执行权限
+
 # 使用说明
+
 ```shell script
 # 添加文件到本地仓库
 git add .
 # 使用-amend参数可覆盖最近一次提交信息，等同于git commit --amend
+# 使用-S参数可进行签署commit操作，等同于git commit -S
 gitcz
 # 推送文件到远程仓库
 git push
 ```
+
 # 规范文档
-gitcz使用：[angular git commit规范](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines)
+
+gitcz 使用：[angular git commit 规范](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines)

gitcz.go

@@ -5,8 +5,6 @@ import (
 	"bytes"
 	"flag"
 	"fmt"
-	"io/ioutil"
-	"log"
 	"os"
 	"os/exec"
 	"strconv"
@@ -19,19 +17,23 @@ type CzType struct {
 }
 
 type CzCommit struct {
-	Type    *CzType
+	Type           *CzType
-	Scope   *string
+	Scope          *string
-	Subject *string
+	Subject        *string
-	Body    *string
+	Body           *string
-	Footer  *string
+	BreakingChange *string
+	Closes         *string
 }
 
 var StdinInput = bufio.NewReader(os.Stdin)
 
 var (
-	InputTypePrompt    = "选择或输入一个提交类型(必填): "
+	InputTypePrompt           = "选择或输入一个提交类型(必填): "
-	InputScopePrompt   = "说明本次提交的影响范围(必填): "
+	InputScopePrompt          = "说明本次提交的影响范围(必填): "
-	InputSubjectPrompt = "对本次提交进行简短描述(必填): "
+	InputSubjectPrompt        = "对本次提交进行简短描述(必填): "
+	InputBodyPrompt           = "对本次提交进行完整描述(选填): "
+	InputBreakingChangePrompt = "如果当前代码版本与上一版本不兼容,对变动、变动的理由及迁移的方法进行描述(选填): "
+	InputClosesPrompt         = "如果本次提交针对某个issue,列出关闭的issues(选填): "
 )
 
 var CzTypeList = []CzType{
@@ -75,6 +77,7 @@ func main() {
 		false,
 		"覆盖上次提交信息",
 	)
+	sign := flag.Bool("S", false, "对commit进行签名")
 	author := flag.Bool(
 		"author",
 		false,
@@ -89,9 +92,12 @@ func main() {
 	czCommit.Type = InputType()
 	czCommit.Scope = InputScope()
 	czCommit.Subject = InputSubject()
+	czCommit.Body = InputBody()
+	czCommit.BreakingChange = InputBreakingChange()
+	czCommit.Closes = InputCloses()
 	commit := GenerateCommit(czCommit)
-	if err := GitCommit(commit, *amend); err != nil {
+	if err := GitCommit(commit, *amend, *sign); err != nil {
-		log.Println(err)
+		fmt.Println(err)
 	}
 }
 
@@ -108,8 +114,8 @@ func NewLine() {
 	fmt.Println()
 }
 
-func GitCommit(commit string, amend bool) (err error) {
+func GitCommit(commit string, amend bool, sign bool) (err error) {
-	tempFile, err := ioutil.TempFile("", "git_commit_")
+	tempFile, err := os.CreateTemp("", "git_commit_")
 	if err != nil {
 		return
 	}
@@ -124,6 +130,9 @@ func GitCommit(commit string, amend bool) (err error) {
 	if amend {
 		args = append(args, "--amend")
 	}
+	if sign {
+		args = append(args, "-S")
+	}
 	args = append(args, "-F", tempFile.Name())
 	cmd := exec.Command("git", args...)
 	result, err := cmd.CombinedOutput()
@@ -154,6 +163,7 @@ func InputType() *CzType {
 			return &CzTypeList[i]
 		}
 	}
+	NewLine()
 	return InputType()
 }
 
@@ -165,6 +175,7 @@ func InputScope() *string {
 		NewLine()
 		return &text
 	}
+	NewLine()
 	return InputScope()
 }
 
@@ -176,22 +187,63 @@ func InputSubject() *string {
 		NewLine()
 		return &text
 	}
-	return InputScope()
+	NewLine()
+	return InputSubject()
+}
+
+func InputBody() *string {
+	fmt.Print(InputBodyPrompt)
+	text, _ := StdinInput.ReadString('\n')
+	text = strings.TrimSpace(text)
+	if text != "" {
+		NewLine()
+		return &text
+	}
+	NewLine()
+	return nil
+}
+
+func InputBreakingChange() *string {
+	fmt.Print(InputBreakingChangePrompt)
+	text, _ := StdinInput.ReadString('\n')
+	text = strings.TrimSpace(text)
+	if text != "" {
+		NewLine()
+		return &text
+	}
+	NewLine()
+	return nil
+}
+
+func InputCloses() *string {
+	fmt.Print(InputClosesPrompt)
+	text, _ := StdinInput.ReadString('\n')
+	text = strings.TrimSpace(text)
+	if text != "" {
+		NewLine()
+		return &text
+	}
+	NewLine()
+	return nil
 }
 
 func GenerateCommit(czCommit *CzCommit) string {
 	commit := fmt.Sprintf(
-		"%s(%s): %s\n",
+		"%s(%s): %s\n\n",
 		czCommit.Type.Type,
 		*czCommit.Scope,
 		*czCommit.Subject,
 	)
 	if czCommit.Body != nil {
 		commit += *czCommit.Body
+		commit += "\n\n"
 	}
-	commit += "\n"
+	if czCommit.BreakingChange != nil {
-	if czCommit.Footer != nil {
+		commit += "BREAKING CHANGE: " + *czCommit.BreakingChange
-		commit += *czCommit.Footer
+		commit += "\n\n"
+	}
+	if czCommit.Closes != nil {
+		commit += "Closes fix " + *czCommit.Closes
 	}
 	return commit
 }

go.mod

@@ -1,3 +1,3 @@
 module github.com/xiaoqidun/gitcz
 
-go 1.15
+go 1.21.2