使用 GitHub Codespaces 生成和调试

项目
11/05/2024

重要

这是 Azure Sphere（旧版）文档。 Azure Sphere（旧版）将于 2027 年 9 月 27 日停用，用户此时必须迁移到 Azure Sphere（集成）。 使用位于 TOC 上方的版本选择器查看 Azure Sphere（集成）文档。

如果你有 GitHub 团队或 GitHub Enterprise Cloud 订阅，则可以使用 GitHub Codespaces 设置项目，使其在 GitHub 托管的容器内生成。使用 Visual Studio Code 的远程功能，可以将桌面上的 Visual Studio Code 连接到 Codespace，直接从 Codespace 编辑、生成、部署和调试。

本主题讨论如何使用 GitHub Codespaces 远程编辑、生成、部署和调试 Azure Sphere 应用; 通过 Visual Studio Code 使用容器进行生成和调试介绍了如何使用 Visual Studio Code 在本地编辑、生成、部署和调试 Azure Sphere 应用。

若要使用 Codespaces，必须将项目配置为 GitHub 存储库，并配置为在容器中使用。在本主题中，你将使用适当的配置创建新的 Blink 项目。

为项目创建 GitHub 存储库

按如下所示创建空 GitHub 存储库：

登录到 github.com。
在 GitHub 主页中，选择“存储库”旁边的“新建”按钮。
为存储库命名（例如 Blink），然后选择“ 创建存储库”。
在“快速设置”下 ，如果之前已执行此操作，请复制存储库的 HTTPS URL。
在命令提示符下，将新存储库克隆到本地桌面，如下所示：
```
git clone <repository-url>
```
应会看到已克隆空存储库的警告。

在克隆中创建新的 Blink 项目

打开 Visual Studio Code 并创建一个新项目，如下所示：

选择“查看>命令面板>Azure Sphere：生成新项目”。
在“选择模板”下，选择“Blink”。
在 “选择文件夹 ”对话框中，指定要在其中创建新项目的文件夹。（这可以随处可见-你将此文件夹的内容复制到之前创建的 GitHub 存储库。
指定与 GitHub 存储库的名称匹配的项目名称，例如 Blink，然后按 Enter。
将 Azure Sphere 项目文件（包括 .vscode 和 HardwareDefinitions 等所有子文件夹）复制到本地克隆、提交和推送更改。然后，可以删除在本部分中创建的项目文件夹，因为所有内容都将位于 GitHub 存储库中。

设置 .devcontainer 文件夹

在 GitHub 存储库的顶级目录中，创建名为 .devcontainer 的文件夹。在此文件夹中，创建包含以下内容的名为devcontainer.json的文件：

{
    "name": "Azure Sphere Blink",
    "runArgs": [ "--cap-add=SYS_PTRACE", "--security-opt", "seccomp=unconfined"],
    "build": {
        "dockerfile": "Dockerfile",
        "target": "dev"
    },

    // Use 'settings' to set *default* container specific settings.json values on container create.
    // You can edit these settings after create using File > Preferences > Settings > Remote.
    "settings": {
        "terminal.integrated.shell.linux": "/bin/bash"
    },

    // Use 'appPort' to create a container with published ports. If the port isn't working, be sure
    // your server accepts connections from all interfaces (0.0.0.0 or '*'), not just localhost.
    // "appPort": [],

    // Uncomment the next line to run commands after the container is created.
    // "postCreateCommand": "gcc -v",

    // Comment out the next line if you want to run as root instead
    "remoteUser": "vscode",

    // Add the IDs of extensions you want installed when the container is created in the array below.
    "extensions": [
        "ms-vscode.azure-sphere-tools",
        "ms-vscode.azure-sphere-tools-ui"
    ]
}

接下来，在 .devcontainer 文件夹中创建包含以下内容的名为 Dockerfile 的文件：

FROM mcr.microsoft.com/azurespheresdk:latest AS dev

FROM dev AS build
COPY ./ /src/
WORKDIR /out
RUN cmake -G "Ninja" -DCMAKE_TOOLCHAIN_FILE="/opt/azurespheresdk/CMakeFiles/AzureSphereToolchain.cmake" \
    -DAZURE_SPHERE_TARGET_API_SET="latest-lts" -DCMAKE_BUILD_TYPE="Release" "/src"
ENTRYPOINT [ "ninja" ]

初始 FROM 行将标准 Azure Sphere Docker 映像指定为基本开发容器，第二行表示将该基本容器用作生成环境。该 COPY 行将存储库的内容复制到容器的 /src/ 目录中。指定 WORKDIR 生成目录。该 RUN 命令提供 CMake 命令来生成生成文件。最后， ENTRYPOINT 指定应调用 ninja 以实际生成应用程序。

将更改提交到 GitHub 项目并推送更改。

安装 GitHub Codespaces 扩展

安装 GitHub Codespaces 扩展：

在 Visual Studio Code 中打开 GitHub 存储库文件夹（如果尚未这样做）。
从 Visual Studio Code 活动栏中打开扩展。
搜索“GitHub Codespaces”并安装 GitHub Codespaces 扩展。

创建 codespace

选择“查看>命令面板>代码空间：创建新的 Codespace”。
在存储库的下拉列表中，选择 “Blink”。如果存储库未显示在下拉列表中，则可以在列表上方的文本框中键入其名称。
从分支的下拉列表中，选择相应的分支。

Visual Studio Code 中的标题栏将更改，以显示你在 Codespaces 中正在编辑。如果在左侧导航栏中打开“扩展”选项卡，则会看到本地安装的扩展和安装在远程容器中的扩展。

生成和调试项目

按 F5 或选择“运行>开始调试”以生成项目并开始调试。应用程序会像往常一样生成并旁加载到设备。如果在代码中设置了断点，应用将运行，直到到达断点为止。可以使用常用的调试命令来演练代码。有关更多详细信息，请参阅 Visual Studio Code 文档中的“调试”主题。

完成调试后，按 Shift+F5 或 “停止” 图标。若要关闭代码空间，请选择“ 查看>命令面板>Codespaces：停止当前 Codespace”。

通过