跳至主要内容

Notion GitHub 整合

利用 Notion 來管理 Sprint 與 Workflow 進度

Notion 與 GitHub 整合​

Notion 與 GitHub 整合的先決條件與設定​

一個 GitHub Organization，一次只能連接一個 Notion Workspace。需 disconnect 後才可更換要連結的 Workspace。

  • Integrate GitHub 官方參考資料
  • 設定方式:   Sidebar   🢂   Settings   🢂   Connections New(上)   🢂   see all   🢂   GitHub (Workspace)   🢂   選取全部或單一 repo   🢂   connect   🢂   帳密驗證  

Notion 端設定

GitHub 端設定

在 Notion 中預覽程式碼​

  • 先到  GitHub   🢂 進入  程式碼頁  (或是其他頁面切換至 code tab) 🢂 可以   Shift   選取多行 🢂 程式碼  行號  處 🢂 滑鼠  右鍵   🢂   __ … __   🢂   Copy Permalink   🢂 取得資源
  • Notion   Page   🢂 貼上   Permalink   🢂   Paste as preview   🢂 若未連接 GitHub 會出現  驗證要求   🢂 畫面自動與指定程式碼同步
    • 點預覽內容可直接跳轉到 GitHub 程式碼原始位置
    • 預覽區右上可 reload

Permalink

Paste as preview

中斷 Notion 與 GitHub 連線設定​

  • Notion 與 GitHub 兩端皆需要進行中斷，才可重新設定
  • 一個 Workspace 只能與一個 GitHub App 綁定

Notion 端移除 GitHub Connection​

  • 兩處設定
    •   Settings   🢂   Connections New(上)   🢂   My Connections   🢂   GitHub   🢂   ...   🢂   Disconnect Account  
    •   Settings   🢂   Connections (下)   🢂   All Connections   🢂   GitHub   🢂   ...   🢂   Disconnect All Users  

GitHub 端移除 Notion Workspace 的 Permissions​

  • 移除設定:   GitHub Home   🢂   右上 portrait   🢂   Settings   🢂   左側欄 Applications   🢂   Authorized OAuth Apps   🢂   Revoke  

GitHub 端移除 Notion 的 GitHub App 綁定​

  • 與上方操作相同先進入   左側欄 Applications   🢂   Installed GitHub Apps   🢂   Configure  

GitHub App 綁定移除

Pull Request (PR) 與 Repo 同步管理:  ​

Developer 請求將 Client 端程式先上傳 Repo 但此時尚未與 Branch 合併，
等管理者同意後才由管理者正式合併。
Notion 可以將 GitHub 上的 PR 進行同步，並做 UI 管理呈現。

  • 官方參考資料
  • GitHub 儲存庫官方參考資料
  • 以 Notion Database 同步管理步驟:
    • 建立連結
      • Notion Page 🢂   /GitHub   🢂   Synced Databases   🢂   Link to GitHub   🢂   選取標的 PR/Issues  
      • GitHub 🢂 複製 PR or issue 的 Link 🢂 Notion Page 🢂 Paste as database
    • Notion database 🢂 + 🢂 新增 property 下會出現 'GitHub Pull Requests' property
    • 建立 'GitHub Pull Requests' property 時 Notion 會自動建立 Unique ID property。
    • 往後在 Notion 中便可以以 Unique ID 來串接 Notion Task 與 GitHub PR。
    • Task 的狀態也可以同步到 PR。