在 Cloud Code for VS Code 中管理自定义示例代码库

使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

示例代码库是一个 Git 代码库,其中包含您创建的自定义示例,您的团队可以使用这些示例来开发应用。

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

示例代码库可以是您已经创建好的示例应用的现有代码库,或者您想要让其他人使用的一组新样本集。如需使用 Cloud Code 导入代码库,请向代码库添加示例描述符文件

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

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

准备工作

确保在本地机器上安装 Git 2.25.0 版或更高版本。

创建示例代码库

如需使用现有代码库,请跳转至创建示例描述符文件。如需创建新的代码库以用作示例代码库,请按照以下步骤操作:

  1. 创建新的 Git 代码库。

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

    GitHub 代码库创建接口,代码库名称字段中填充了“custom-sample-repo”

  2. 将示例目录添加到代码库中。

    您的示例目录可以包含任何内容,可以位于代码库中的任何位置。在此示例中,“hello-world”和“kubernetes-custom-sample”有两个示例目录已添加到“custom-sample-repo”。

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

    “custom-sample-repo”有两个基本示例目录:“hello-world”和“kubernetes-custom-sample”

  3. 创建示例描述符文件。

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

  4. 按照通过自定义示例创建应用中的步骤测试自定义示例。

示例描述符架构

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

示例

{
   "metadata":{
      "version":"1"
   },
   "name": "My Sample Repository",
   "templates":[
      {
         "path":"/path/to/sample1_location",
         "name":"My Sample 1",
         "description":"The first sample of its name."
      },
      {
         "path":"/path/to/sample2_location",
         "name":"My Sample 2",
         "description":"The sequel."
      }
   ]
}

示例架构

密钥 说明 类型
路径 示例在代码库中的位置。
路径相对于代码库的根目录。
字符串
名称 示例的名称。
在选择基于应用的示例时,IDE 中会显示该名称。
字符串
说明(可选) 示例的说明。
当选择基于的应用示例时,说明会显示在 IDE 中。
字符串

示例

{
   "path":"path/to/sample1",
   "name":"My Sample 1",
   "description":"The first sample of its name."
}

元数据架构

密钥 说明 类型
版本 要使用的示例架构版本。唯一的有效版本是 1 字符串

示例

{
   "version":"1"
}

删除自定义示例代码库

要删除自定义示例,从而将其从自定义应用选择器流和用户及其中删除,请执行以下操作:

  1. settings.json 文件中,查找自定义示例条目的 localPath

    "cloudcode.customApplications": [
      {
        "repoUrl": https://github.com/GoogleCloudPlatform/cloud-code-custom-samples-example.git,
        "branchName": "",
        "localPath": "/Users/username/Library/cloud-code/custom-templates/https-github-com-google-cloud-platform-cloud-code-custom-samples-example-git"
      }
    ],
    
  2. 删除路径中的模板文件夹。

  3. settings.json 文件中删除自定义示例部分。

获取支持

如需发送反馈,请在 GitHub 上报告问题,或者在 Stack Overflow 上提问。