设置模板代码库

模板代码库是一个 Git 代码库,其中包含您创建的入门模板,您的团队可以使用该模板来开发应用。

这意味着,在组织或团队中,您可以使用 Cloud Code 设置模板代码库并针对您的组织进行自定义,以提供一组可供其他人使用的标准入门应用、服务和基础架构配置。这有助于使新项目与贵组织的首选技术堆栈和标准保持一致,并鼓励在开发周期开始时采用最佳做法。

模板代码库可以是您已创建的应用模板或者您希望其他人使用的一组全新模板的现有代码库。您只需要将模板描述符文件添加到代码库,以便使用 Cloud Code 将其导入。

准备就绪之后,您就可以轻松将其与您的团队共享;它们要求设置 Cloud Code,还需要待使用的模板代码库的 Git 网址。对于专用 Git 代码库,只有有权访问代码库的成员才能使用底层自定义模板。

如需查看如何设置模板代码库的示例,请参阅此示例代码库

创建新的模板代码库

如果您想创建全新的模板代码库以供使用,请按以下步骤操作:

  1. 创建新的 Git 代码库。

    您的 Git 代码库可以远程托管,也可以驻留在本地机器上。本示例使用全新的 GitHub 代码库“my-template-repository”。

    GitHub 代码库创建接口,代码库名称字段中填充了“my-template-repository”

  2. 向此代码库添加模板目录。

    您的模板目录可以包含任何内容,可以位于代码库中的任何位置。在本示例中,“template1”和“template2”这两个模板目录都包含一个 readme 文件,每个目录均包含“my-template-repository”。

    强烈建议提供 readme 文件,并在其中说明如何使用自定义模板。

    包含“template1”和“template2”两个基础模板目录的“my-template-repository”

  3. 创建模板描述符文件。

    模板描述符文件为 Cloud Code 提供有关您的模板的信息,以保证正确创建应用。此文件必须命名为 .cctemplate(位于根目录中),并且必须在模板描述符文件架构部分中定义架构。

使用现有代码库

如果想要使用现有代码库,您仍然需要创建模板描述符文件。此文件为 Cloud Code 提供有关您的模板的信息,以保证正确创建应用。

您的模板描述符文件必须命名为 .cctemplate(位于根目录中),并且必须在模板描述符文件架构部分中定义架构。

模板描述符架构

密钥 说明 类型
元数据 Cloud Code 用于读取的元数据。 符合元数据架构 元数据
模板 代码库中包含的模板数组。此数组中的对象应符合模板架构 数组<模板>
名称(可选) 模板代码库的名称。 字符串

示例

{
   "metadata":{
      "version":"1"
   },
   "name": "My Template Repository",
   "templates":[
      {
         "path":"/path/to/template1_location",
         "name":"My Template 1",
         "description":"The first template of its name."
      },
      {
         "path":"/path/to/template2_location",
         "name":"My Template 2",
         "description":"The sequel."
      }
   ]
}

模板架构

密钥 说明 类型
路径 模板在代码库中的位置。

路径表示相对于代码库的根目录的路径。

字符串
名称 模板名称。

选择一个模板以用作构建应用的基础时,此名称会在 IDE 中显示。

字符串
说明(可选) 模板的说明。

选择一个模板以用作构建应用的基础时,此名称会在 IDE 中显示。

字符串

示例

{
   "path":"path/to/template1",
   "name":"My Template 1",
   "description":"The first template of its name."
}

元数据架构

密钥 说明 类型
版本 正在使用的模板架构的版本。目前唯一有效的版本是 1 字符串

示例

{
   "version":"1"
}