2016 年 07 月 27 日

連結 GitHub 和 YouTrack 追蹤事項

原文:  Adding YouTrack issue links on GitHub

本翻譯由JetBrains授權. 此為JetBrains的客座部落客Nuno Pinherio, Chrome extension for navigating to your issues from a GitHub commit/PR page.的作者. 如對本文所述有任何問題, 歡迎到原文下提問. 

YouTrack 為 JetBrains 的追蹤事項軟體/雲端服務.

當你考慮一個專案要用什麼樣的事項追蹤工具, 如果這專案在GitHub上進行, 採用GitHub的事項追蹤(Issue)很簡單. 不用做任何設定, 在GitHub的交付(commit)和意見說明(comment)只要你有做參考動作就會出現程式碼連結於追蹤事項上.  不過如果你做的是比較專業的專案, 有可能你會想要比較強的事項追蹤工具, 如YouTrack這類有統計報告與流程管理等功能.

當採用YouTrack, 你將希望可以 將你的程式碼貯存庫(repository)和你的事項追蹤整合.  如此的整合能從你的交付去參考相關事項, 且YouTrack也能告訴你事項相關的程式碼交付(commit)和拉碼要求(PR-Pull Requests).  以那些交付. 你可以對多個事項下令執行操作.

我覺得就是少了這一塊, 當用GitHub事項追蹤時, 從交付的程式碼/PR那頁導覽到GitHub的事項追蹤(Issue)輕而易舉.  但如果用的是外部的事項追蹤如YouTrack, GitHub不會知道要參考哪個事項, 且不會提供你的事項任何連結.  這也就是說如果有人在交付程式碼或做PR時寫上相關事項的ID, 你必須手動複製這個事項ID, 然後打開YouTrack, 將這ID填到搜尋欄找出這事項.  這樣的動作在你需要查驗許多交付和PR,了解他們的參考事項時, 會變得很煩且費時.  也許在選擇事項追蹤工具時你不覺得這很重要, 但實務上對你的團隊的運作將有很重大的影響.

為了解決這問題, 希望每天能省一些時間, 我開發了Google Chrome的擴充件, 在GitHub加了這功能! 這個可設定的擴充件(外掛)會偵測到你導覽到GitHub頁面, 並檢查目前你所在的專案是否被設置連結到YouTrack的貯藏庫(repository). 如果是, 它將把這頁所有的事項ID找出, 然後將這些事項的連結注入YouTrack頁相對的事項.
GitHub link injection sample

與JetBrains討論, 他們幫助我更進一步. 經由既有的RESTful API, 除了注入一個直接的連結到追蹤頁面, 我們加入一個預覽, 包含摘要和敘述. 假如你的追蹤工具非公開的, 你必須先登入才能啟動這功能.

安裝與設定

你可從 Chrome網路商店來安裝外掛. 如果你有興趣, 也可把 source code打包自己做外掛.

安裝後, 你只要點網域地址橫條旁的按鈕, 就可以到管理畫面.

toolbaricon

到管理畫面, 你可讀取、製作、更新或刪除現有的設定.

repositorymanagement

每個設定都包含四個欄位:

  1. 貯存庫(Repository) – 貯存庫(repository)的名稱
  2. 關鍵名稱(Key) – 你的YouTrack事項(issues)的短名
  3. 目標連結(TargetUrl) – 用來建立事項連結的YouTrack URL
  4. 型(Type) – 事項追蹤的類型

點選輸入鍵(import), 並把你的URL貼入, 即可開始輸入的設定.  如果你的解決方案有上下文路徑(context path), 別忘了把它加到連結.  例如, 如果你用的雲端代管的解決方案, 你將需要在URL加上 “/youtrack”.

importsample

這外掛無法從專案來抓取GitHub貯存庫(repository)的資料, 所以它會試著從你於YouTrack上設定的名稱來猜猜看專案的名稱.  例如, 從 https://youtrack.jetbrains.com/ 載入專案時, 有的像kotlin的專案, 這樣的名稱就很容易猜對. 不過有的你可能還是需要進去修改一下.

resultssample

此外掛允許對於同一程式碼貯存庫(repository)做多個設定, 這讓你可以解決YouTrack多個專案內的多個事項.  所有設定都會同步到你的Google帳號. 這意指你只需要輸入設定一次, 在跟你的帳號連結的Chrome瀏覽器上都將會有這些設定.

由於軟體建置和事項追蹤都是為了團隊合作, 管理的畫面也包含了輸出的功能. 若你想輸出, 選擇所有你想要輸出的設定, 點 export 按紐,將秀出一個 json表達的設定資訊. 只要簡單複製, 貼到一個檔案、文件或email, 即可分享給你的同事.

如果要輸入那些設定資料, 只要點 import 按紐, 從“Import From”選擇Exported Json選項, 貼上這些設定即可.

 

YouTrack 10 seats免費, 歡迎下載使用

歡迎加入JetBrains Taiwan-Team Tools 社群

DevOps相關書籍

發表迴響

在下方填入你的資料或按右方圖示以社群網站登入:

WordPress.com Logo

您的留言將使用 WordPress.com 帳號。 登出 / 變更 )

Twitter picture

您的留言將使用 Twitter 帳號。 登出 / 變更 )

Facebook照片

您的留言將使用 Facebook 帳號。 登出 / 變更 )

Google+ photo

您的留言將使用 Google+ 帳號。 登出 / 變更 )

連結到 %s

分類

未分類