將範本提交到社群範本庫

貴機構可透過 Google 代碼管理工具社群範本庫，建立及管理與 Google 代碼管理工具原生整合的代碼和變數範本。貴機構可以建構範本、將範本存放區發布至 GitHub，然後將範本提交至社群範本庫，供全球使用者使用。貴機構可享有的好處包括：

• 客戶就能輕鬆新增及使用範本。
• 代碼管理工具使用者會看到貴機構的品牌。
• 客戶只需幾分鐘就能部署代碼，不必等待數月。
• 您可以發布範本更新，讓客戶自動取得最新版本。

如要將新範本提交至社群範本庫，請按照下列主要步驟操作：

1. 建構範本
2. 準備專案檔案
3. 將檔案上傳至 GitHub
4. 提交範本

建立範本

如要開始使用，請在 Google 代碼管理工具中建立自訂範本。請務必徹底測試範本，確保範本內容符合樣式指南，並制定維護及更新範本的計畫或程序，以備不時之需。

服務條款

每次提交新範本時，都必須同意 Google 代碼管理工具社群範本庫的《服務條款》。如要確認同意範本的《服務條款》，請按照下列步驟操作：

1. 閱讀 Google 代碼管理工具社群範本庫服務條款。
2. 在範本編輯器中開啟範本進行編輯，然後勾選「資訊」分頁下方的「同意《社群範本庫服務條款》」方塊。

匯出範本

範本完成後，請匯出範本檔案至本機，並將檔案重新命名為 template.tpl。

準備專案檔案

下一個步驟是準備在 GitHub 發布存放區。每個存放區都應包含下列檔案：

1. 名為 template.tpl 的匯出範本檔案。這個檔案必須更新，才能新增 categories 項目。
2. metadata.yaml 檔案。
3. LICENSE 檔案。檔案名稱必須全部大寫，授權檔案內容只能是 Apache 2.0。
4. 新增 README.md 檔案 (選填，但建議使用)。

在「template.tpl」中新增類別

在 template.tpl 檔案的 INFO 區段中新增 categories 項目，並從下表選取至少一個相關類別值。如果有多個適用的類別，最多可以提供三個類別值，並依相關程度排序。

範例：

___INFO___

{
  "displayName": "Example Template",
  "categories": ["AFFILIATE_MARKETING", "ADVERTISING"],
  // additional template properties, etc...
}

支援的類別值表格：

metadata.yaml

metadata.yaml 檔案包含範本資訊，包括貴機構首頁、範本說明文件和版本資訊的連結。每個版本都以變更編號 (又稱 SHA 編號) 表示，這是與 Git 提交作業相關聯的變更編號。changeNotes 欄位為選填欄位，但建議您填寫，讓使用者瞭解該版本包含的變更。

如何設定 metadata.yaml 檔案：

1. 新增項目 homepage。這應是貴機構首頁的網址。
2. 新增 documentation 的項目。這個網址應指向範本的說明文件。
3. 在 GitHub 中，找出包含要推送的變更 (範本初始版本) 的修訂項目，然後複製 SHA 編號。如要在 GitHub 中輕鬆取得 SHA 編號，請前往提交檢視畫面，然後按一下剪貼簿圖示 ()。這樣就會將整個 SHA 編號複製到剪貼簿。將該數字貼到 sha 項目中，做為 versions 節點的子項，如下所示。
4. 在 versions 節點中新增 changeNotes 項目，簡要說明這個新版本包含的變更。

homepage: "https://www.example.com"
documentation: "https://www.example.com/documentation"
versions:
  - sha: 5f02a788b90ae804f86b04aa24af8937e567874a
    changeNotes: Initial release.

上傳至 GitHub

下一步是將檔案上傳至 GitHub。按照上述說明，建立含有適當檔案和結構的 GitHub 存放區。

範本存放區必須在 Git 存放區的根層級中，包含 * template.tpl、metadata.yaml 和 LICENSE 檔案。每個 Git 存放區只能有一個 template.tpl 檔案。所有資源都必須位於 GitHub 存放區的主分支。如果範本存放區不符合這個結構，就會從範本庫中移除。

社群範本庫中的每個項目都會連結至範本 GitHub 存放區的「問題」部分，方便使用者回報錯誤。

提交範本

範本存放區在 GitHub 上架後，即可將範本提交至社群範本庫。如要提交範本，請按照下列步驟操作：

1. 請務必使用有權存取要新增至範本庫的範本存放區的帳戶登入 GitHub。
2. 前往社群範本庫 (tagmanager.google.com/gallery)。
3. 按一下 more_vert，然後選取「提交範本」。
4. 在提供的欄位中輸入「存放區網址」，然後按一下「提交」。

更新範本

發布範本後，您可能需要不時更新範本。範本更新時，範本使用者會收到通知，並可選擇將範本更新至最新版本。

系統會根據 metadata.yaml 檔案，判斷要在範本庫中使用哪個範本版本。如要發布新版本，請將變更號碼 (SHA 號碼) 新增至 metadata.yaml 檔案的 versions 區段。

1. 找出包含要推送變更的提交，然後複製 SHA 編號。在 GitHub 中，前往提交檢視畫面，然後按一下剪貼簿圖示 ()，即可輕鬆完成這項操作。這樣一來，整個 SHA 編號就會複製到剪貼簿。
2. 在 metadata.yaml 中，將新的 sha 項目新增至 versions 清單頂端。(請參閱下方範例)。
3. 新增 changeNotes，簡要說明這個新版本包含的變更。您可以視需要建立多行註解。(請參閱下方範例)。
4. 將變更提交至 metadata.yaml，更新內容通常會在 2 到 3 天內顯示在代理庫中。

本範例說明如何新增版本資訊，包括 SHA 編號和變更記錄：

homepage: "https://www.example.com"
documentation: "https://www.example.com/documentation"
versions:
  # Latest version
  - sha: 5f02a788b90ae804f86b04aa24af8937e567874c
    changeNotes: |2
      Fix bug with the whatsamajig.
      Improve menu options.
      Update API calls.
  # Older versions
  - sha: 5f02a788b90ae804f86b04aa24af8937e567874b
    changeNotes: Adds eject button.
  - sha: 5f02a788b90ae804f86b04aa24af8937e567874a
    changeNotes: Initial release.

移動存放區

如要變更擁有者或存放區名稱，可以使用 GitHub 存放區轉移程序。系統會偵測新位置，並在使用者下次更新範本時，自動將他們轉送至新存放區。

移除範本

如要從範本庫中移除範本，請從存放區中刪除 LICENSE 檔案或 metadata.yaml 檔案。圖庫監控系統會偵測到這項變更，並自動移除範本。