跳至主要内容

向 devcontainer.json 文件添加功能

使用功能,您可以快速将工具、运行时或库添加到您的开发容器配置中。

功能是安装代码和开发容器配置的独立单元,旨在跨广泛的基础容器镜像工作。您可以使用功能快速将工具、运行时或库添加到您的 Codespace 镜像中。有关更多信息,请参阅 可用功能功能规范 在开发容器网站上。

您可以从 VS Code 或 GitHub.com 上的存储库中向 devcontainer.json 文件添加功能。使用本文中的选项卡显示添加功能的每种方式的说明。

devcontainer.json 文件添加功能

  1. 导航到 GitHub.com 上的存储库,找到您的 devcontainer.json 文件,然后单击 以编辑文件。

    如果您还没有 devcontainer.json 文件,现在可以创建一个。有关更多信息,请参阅“Dev 容器简介”。

  2. 在文件编辑器的右侧,在“市场”选项卡中,浏览或搜索要添加的功能,然后单击功能名称。

    Screenshot of the "Marketplace" tab with "Terra" in the search box and the Terraform feature listed in the search results.

  3. 在“安装”下,单击代码段以将其复制到剪贴板,然后将代码段粘贴到 devcontainer.json 文件中的 features 对象中。

    Screenshot of the "Marketplace" tab showing the installation code snippet for Terraform.

    "features": {
         // ...
         "ghcr.io/devcontainers/features/terraform:1": {},
         // ...
     }
    
  4. 默认情况下,将使用功能的最新版本。要选择其他版本或配置功能的其他选项,请展开“选项”下列出的属性以查看可用值,然后通过手动编辑 devcontainer.json 文件中的对象来添加选项。

    Screenshot of the "Options" section of the "Marketplace" tab, with the "version" and "tflint" properties expanded.

    "features": {
         // ...
         "ghcr.io/devcontainers/features/terraform:1": {
             "version": "1.1",
             "tflint": "latest"
         },
         // ...
     }
    
  5. 提交对 devcontainer.json 文件的更改。

配置更改将在从存储库创建的新代码空间中生效。要使更改在现有代码空间中生效,您需要将对 devcontainer.json 文件的更新拉取到您的代码空间中,然后重建代码空间的容器。有关更多信息,请参阅“Dev 容器简介”。

要在本地工作时(未连接到代码空间)在 VS Code 中添加功能,您必须安装并启用“Dev Containers”扩展。有关此扩展的更多信息,请参阅 VS Code 市场

  1. 使用 Shift+Command+P(Mac)或 Ctrl+Shift+P(Windows/Linux)访问 VS Code 命令面板。

  2. 开始输入“add dev”,然后点击**Codespaces:添加开发容器配置文件**。

    Screenshot of the Command Palette, with "add dev" entered and "Codespaces: Add Dev Container Configuration Files" listed.

  3. 点击**修改您的活动配置**。

  4. 更新您的功能选择,然后点击**确定**。

  5. 如果您在 codespace 中工作,右下角将出现一个提示。要重建容器并将更改应用于您正在使用的 codespace,请点击**立即重建**。

    Screenshot of the message: "We've noticed a change to the dev container configuration." Below this is the "Rebuild Now" button.