處理問題和提取要求

本頁說明如何在 Secure Source Manager 網頁介面處理問題和提取要求。

如要透過網頁介面存取 Secure Source Manager 執行個體,請將下列網址複製到瀏覽器的網址列。

INSTANCE_ID-PROJECT_NUMBER.LOCATION.sourcemanager.dev

請替換下列項目:

  • INSTANCE_ID 替換為執行個體名稱。
  • PROJECT_NUMBER 換成執行個體的 Google Cloud 專案編號。如要瞭解如何識別專案,請參閱「識別專案」。
  • LOCATION 與執行個體區域相同。

必要的角色

如要取得處理問題和提取要求的權限,請要求管理員授予下列 IAM 角色:

  • Secure Source Manager 執行個體存取者 (roles/securesourcemanager.instanceAccessor) Secure Source Manager 執行個體
  • 存放區的Secure Source Manager 存放區寫入者 (roles/securesourcemanager.repoWriter)

如要進一步瞭解如何授予角色,請參閱「管理專案、資料夾和組織的存取權」。

您或許也能透過自訂角色或其他預先定義的角色,取得必要權限。

如要瞭解如何授予 Secure Source Manager 角色,請參閱「使用 IAM 控管存取權」和「授予使用者執行個體存取權」。

查看提取要求

您可以查看自己有權存取的所有提取要求,或是特定存放區的提取要求。

空白存放區沒有「提取要求」分頁標籤。推送至存放區後,即可查看提取要求分頁。

如要查看指派給您的提取要求或問題,請前往 Secure Source Manager 的「問題」或「提取要求」分頁,然後點選「指派給我」。

如要查看存放區的提取要求:

  1. 在 Secure Source Manager 網頁介面中,選取存放區。
  2. 在存放區頁面中,按一下「Pull requests」分頁標籤。
  3. 您可以使用「受讓人」、「類型」或「排序」的下拉式選單,篩選或排序提取要求。

如要查看所有提取要求:

  1. 在 Secure Source Manager 網頁介面中,按一下「提取要求」分頁標籤。

  2. 您可以使用「受讓人」、「類型」或「排序」的下拉式選單,篩選或排序提取要求。

建立提取要求

  1. 在 Secure Source Manager 網頁介面中,選取要建立提取要求的存放區。
  2. 在存放區頁面中,按一下「Pull requests」(提取要求) 分頁標籤。
  3. 按一下 [New pull request] (新的提取要求)。
  4. 在「併入」選單中,選取要將提取要求併入的分支版本。
  5. 在「pull from」選單中,選取要從哪個分支版本提取。
  6. 按一下 [New pull request] (新的提取要求)。
  7. 為提取要求加上標題和說明,並附上任何相關檔案。
  8. 按一下「建立提取要求」。

    系統會將您帶往「提取要求」頁面,您可以在這裡新增審查人員、標籤、里程碑和指派對象。

編輯提取要求詳細資料

您可以為提取要求新增審查人員、標籤、里程碑、指派對象和截止日期。

如要新增審查者、標籤、重要時程、指派對象:

在提取要求頁面中,點選要編輯的詳細資料旁邊的齒輪圖示 齒輪圖示。

系統會自動儲存編輯內容。

如要更新「截止日」,請按照下列步驟操作:

  1. 按一下「截止日」部分中的日曆圖示,然後選取日期。
  2. 按一下 加號圖示 「加號」圖示,即可儲存截止日期。

查看提取要求

審查者可以新增註解、要求變更及核准提取要求。

如要查看指派給你的提取要求,請按照下列步驟操作:

  1. 在 Secure Source Manager 網頁介面中,按一下「提取要求」分頁標籤。
  2. 按一下「指派給您」。
  3. 按一下要查看的提取要求。

    「對話」頁面隨即開啟。你可以查看提取要求作者或其他審查員留下的任何留言。

  4. 如要查看及加註變更的檔案,請按一下「變更的檔案」分頁標籤。 如要變更空白字元顯示方式、檢視畫面和差異比較選項,請按一下「空白字元」、「分割檢視畫面」/「統一檢視畫面」和「差異比較選項」下拉式選單。

  5. 如要留言,請點按要留言的行旁邊的加號圖示。

  6. 按一下「開始檢查」。

  7. 如要新增其他註解,請在要註解的行上按一下加號圖示,然後按一下「新增註解」。

    註解支援使用 Markdown 設定樣式。

  8. 如要傳送留言、核准提取要求或要求變更,請按一下「審查」。

  9. 留言總結變更內容,或將留言空間留空,然後選取下列選項:

    • 「核准」:核准變更。
    • 留言:傳送留言,不必核准提取要求。
    • 要求變更:要求變更提取要求。

合併提取要求

  1. 在存放區頁面中,按一下「Pull requests」(提取要求) 分頁標籤。
  2. 選取要合併的提取要求。
  3. 如果沒有衝突,請按一下「Merge pull request」(合併提取要求)。

查看問題

  1. 在 Secure Source Manager 網頁介面中,選取存放區。
  2. 在存放區頁面中,按一下「問題」分頁標籤。
  3. 你可以使用「受讓人」、「類型」或「排序」選單,篩選或排序問題。

建立問題

  1. 在 Secure Source Manager 網頁介面中,選取存放區。
  2. 在存放區頁面中,按一下「問題」分頁標籤。
  3. 按一下「New Issue」。
  4. 輸入問題標題和說明,然後按一下「建立問題」。
  5. 在「問題詳細資料」頁面,您可以指派標籤、里程碑、指派對象,並指定分支版本或標記。

使用 Mermaid 新增圖表

Secure Source Manager 支援在 Markdown 檔案 (例如 README.md)、提取要求說明、問題和註解中,算繪 Mermaid 圖表。

如要新增圖表,請使用 mermaid 圍籬式程式碼區塊:

```mermaid
graph TD
    A[Write Markdown] --> B(Click Preview Tab)
    B --> C{Does it render?}
    C -- Yes --> D[Success]
    C -- No --> E[Check Syntax]
```

在 Markdown 編輯器中按一下「預覽」分頁標籤,確認圖表是否能順利顯示,再儲存變更。

支援的圖表類型

Secure Source Manager 支援下列 Mermaid 圖表類型:

  • 流程圖:graph 或 flowchart (支援 TD、TB、LR、BT、RL)
  • 序列圖:sequenceDiagram
  • 類別圖:classDiagram
  • 實體關係圖:erDiagram
  • 狀態圖:stateDiagram 或 stateDiagram-v2
  • XY 圖表:xychart-beta 或 xychart

轉譯行為和限制

  • 靜態算繪:圖表會算繪為靜態圖片。為確保安全,互動功能 (例如 click 回呼和工具提示) 和外部指令碼會停用。
  • 主題調整:圖表會自動調整為淺色和深色主題。
  • 無障礙功能:系統會為算繪的圖表提供替代文字,並填入圖表的原始碼,供螢幕閱讀器使用。
  • 不支援的圖表類型:不支援的圖表類型會顯示錯誤訊息,且不會轉譯。包括甘特圖、心智圖、圓餅圖、Gitgraph、使用者歷程、需求、C4、時間軸、桑基圖和方塊圖。如果圖表類型不受支援,請在本地將圖表算繪為圖片 (PNG 或 SVG),然後使用標準 Markdown 圖片語法嵌入圖片。

後續步驟