gitlab-assistant v1.1.18

Gitlab-Assistant

Gitlab 輔助工具集
    本項輔助工具可透過在不同專案目錄中，建立各自獨立的設定檔，並運用設定內容來進行對 Gitlab 的 API 呼叫。配合 Git 指令可協助在操作上更為便利，減少在不同介面中切換的繁瑣。
    另外亦支援 Universal Assistant UA 系統，可進行 Commit 與 UA 任務／規劃的綁定，成為 UA 與 Gitlab 間的串連橋樑，進一步減少介面切換。

使用說明

安裝

這是一個命令列工具，建議使用以下指令進行全域安裝：

npm i -g gitlab-assistant

Usage: ga <Commands> Options

Commands:

• init 建立並設定基本資訊設定檔
• info 顯示基本資訊設定
• update
  特定基本資訊項目內容變更
  -e | --endpoint 變更 Gitlab API 伺服器位址
  -p | --project 變更 Gitlab 專案代碼
  -a | --pat 變更 Gitlab Personal Access Token
  -b | --branch 變更 Gitlab 目標分支名稱
  -f | --filter 變更 Gitlab 分支限定規則(正則表示)
  -c | --committemp 變更 Commit 描述範本檔案
  -m | --mrtemp 變更 Merge Request 描述範本檔案
  -t | --bundletitle 變更 是否顯示綁定於標題設定
  -s | --userver 變更 UA API 伺服器位址
  -x | --upat 變更 UA Personal Access Token
• ignores
  Gitlab User 排除清單管理
  -a | --add 新增 排除對象
  -d | --del 移除 排除對象
  -l | --list 顯示 排除對象
• prefixs
  Commit 類型標籤管理
  -a | --add 新增 Commit 類型標籤
  -d | --del 移除 Commit 類型標籤
  -l | --list 顯示 Commit 類型標籤
• commit | co
  以詢答方式建立 Commit，並可配合 UA API 取得任務／規劃資訊或建立任務並進行綁定
  -u | --update 以最後一次 Commit 內容重新進行綁定並變更其訊息
  -r | --reset 配合 -u | --update 使用，清空最後一次 Commit 內容中的綁定訊息。單獨使用無效
• mr
  以詢答方式使用 Gitlab API 發送 Merge Request 要求
• mra
  以詢答方式使用 Gitlab API 發送 Merge Request Approve 要求

asset.json 範例(可透過 ga init 產生)

        {
            //Gitlab API 伺服器位址
            "endpoint": "http://192.168.1.2",
            //Gitlab 專案代碼
            "project": 9999,
            //Gitlab Personal Access Token
            "pat": "X9yUq-Wb3d-KjP-pQ8z-L1",
            //Gitlab 目標分支名稱 
            "branch": "main",
            //Gitlab 分支限定規則(正則表示)  
            "branchfilter": "testbranch|branch/*", 
            //Gitlab User 排除清單
            "ignores": [
                "User1",
                "User2"
            ],
            //Commit 類型標籤  
            "commitprefixs": [
                {
                    //短名稱
                    "short": "[feat]",
                    //選項名稱
                    "name": "[feat] 新增/修改功能 (feature)",
                    //標籤值
                    "value": "[feat]"
                },
                {
                    "short": "[fix]", 
                    "name": "[fix] 修補 bug",
                    "value": "[fix]"
                }
            ],
            //Commit 描述範本檔案
            "commitdescfile": "tempCommit.md",
            //Merge Request 描述範本檔案
            "mrdescfile": "tempMR.md",
            //是否顯示綁定資訊於標題
            "bundletitle": true,
            //UA API 伺服器位址
            "uaendpoint": "http://192.168.1.1:999",
            //UA Personal Access Token
            "uapat": "AbCdEf09"
        }