將範本提交到社群範本庫

透過集合功能整理內容 你可以依據偏好儲存及分類內容。

您的機構可透過 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 中新增類別

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

範例：

___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 存放區的「Issues」部分，方便使用者在發現錯誤時通知您。請確認範本的 GitHub 存放區未停用問題，以便您查看及解決任何問題。

提交範本

範本存放區在 GitHub 上託管後，您就可以繼續將範本提交至社群服務範本庫。如要提交範本，請按照下列步驟操作：

1. 請確認您登入 GitHub 時，使用的是具備存放區存取權的帳戶，才能將範本存放區新增至相片庫。
2. 前往 tagmanager.google.com/gallery 的社群範本庫。
3. 按一下 more_vert，然後選取「提交範本」。
4. 在提供的欄位中提供「存放區網址」，然後按一下「提交」。

更新範本

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

metadata.yaml 檔案可用於判斷在範本庫中要使用的範本版本。如要發布新版本，您必須在 metadata.yaml 檔案的 versions 區段中新增變更號碼 (SHA 號碼)。

1. 找出包含要推送變更的提交內容，然後複製 SHA 編號。在 GitHub 中，您可以前往修訂檢視畫面，然後按一下剪貼簿圖示 ()，將整個 SHA 編號複製到剪貼簿。
2. 在 metadata.yaml 的 versions 清單頂端新增 sha 項目。(請���閱下方範例)。
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 檔案。圖庫監控系統會偵測這項變更，並自動移除範本。