docs(更新文档): 更新文档

.drone.yml

@@ -1,28 +0,0 @@
-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: ccr.ccs.tencentyun.com/xiaoqidun/goenv
-    commands:
-      - ./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/

.gitea/workflows/build.yaml

@@ -0,0 +1,28 @@
+on: [push, workflow_dispatch]
+jobs:
+  build:
+    runs-on: cn
+    steps:
+      - name: checkout
+        uses: actions/checkout@v6
+      - name: generate
+        uses: docker://ccr.ccs.tencentyun.com/xiaoqidun/build:latest
+        with:
+          args: -f build.sh -i gitcz.go -o release/gitcz
+      - name: docker goenv
+        uses: docker://ccr.ccs.tencentyun.com/xiaoqidun/goenv:latest
+        env:
+          GIT_SERVER: ${{ secrets.git_server }}
+          GIT_USER: ${{ secrets.git_user }}
+          GIT_TOKEN: ${{ secrets.git_token }}
+        with:
+          args: bash build.sh
+      - name: upload to cos
+        uses: docker://ccr.ccs.tencentyun.com/xiaoqidun/gocos
+        env:
+          PLUGIN_SECRET_ID: ${{secrets.cos_secret_id}}
+          PLUGIN_SECRET_KEY: ${{secrets.cos_secret_key}}
+          PLUGIN_BUCKET_URL: ${{secrets.cos_bucket_url}}
+          PLUGIN_SOURCE: release/
+          PLUGIN_TARGET: product/gitcz
+          PLUGIN_STRIP_PREFIX: release/

.gitignore

@@ -1 +1,3 @@
 .idea/
+.vscode/
+.devcontainer/

README.md

@@ -1,10 +1,12 @@
 # gitcz
 
-Golang 版本 Git Commitizen，commit 规范工具
+Go语言Git Commitizen，commit规范工具
 
 # 快速安装
 
+```
 go install github.com/xiaoqidun/gitcz@latest
+```
 
 # 编译安装
 
@@ -35,4 +37,4 @@ 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

@@ -32,8 +32,8 @@ var (
 	InputScopePrompt          = "说明本次提交的影响范围(必填): "
 	InputSubjectPrompt        = "对本次提交进行简短描述(必填): "
 	InputBodyPrompt           = "对本次提交进行完整描述(选填): "
-	InputBreakingChangePrompt = "如果当前代码版本与上一版本不兼容,对变动、变动的理由及迁移的方法进行描述(选填): "
-	InputClosesPrompt         = "如果本次提交针对某个issue,列出关闭的issues(选填): "
+	InputBreakingChangePrompt = "如果当前代码版本与上一版本不兼容, 对变动、变动的理由及迁移的方法进行描述(选填): "
+	InputClosesPrompt         = "如果本次提交针对某个issue, 列出关闭的issues(选填): "
 )
 
 var CzTypeList = []CzType{

go.mod

@@ -1,3 +1,3 @@
 module github.com/xiaoqidun/gitcz
 
-go 1.21.1
+go 1.21.0