Použití GitHub Codespaces k sestavení a ladění

Článek
09/27/2024

Důležité

Toto je dokumentace k Azure Sphere (starší verze). Azure Sphere (starší verze) se vyřazuje 27. září 2027 a uživatelé musí do této doby migrovat do Azure Sphere (integrované). K zobrazení dokumentace k Azure Sphere (integrované) použijte selektor verzí umístěný nad obsahem.

Pokud máte předplatné GitHub Team nebo GitHub Enterprise Cloud, můžete pomocí GitHub Codespaces nastavit projekt tak, aby se sestavil uvnitř kontejneru hostovaného GitHubem. Pomocí vzdálené funkce editoru Visual Studio Code můžete visual Studio Code na ploše připojit k codespace a upravovat, sestavovat, nasazovat a ladit přímo z Codespace.

Toto téma popisuje použití GitHub Codespaces k úpravám, sestavování, nasazování a ladění aplikací Azure Sphere vzdáleně; Použití kontejnerů k sestavení a ladění pomocí editoru Visual Studio Code popisuje použití editoru Visual Studio Code k úpravám, sestavování, nasazování a ladění aplikací Azure Sphere v kontejneru místně.

Pokud chcete používat Codespaces, musí být váš projekt nakonfigurovaný jako úložiště GitHubu a také nakonfigurovaný pro použití v kontejneru. V tomto tématu vytvoříte nový projekt Blink s odpovídající konfigurací.

Vytvoření úložiště GitHub pro váš projekt

Následujícím způsobem vytvořte prázdné úložiště GitHub:

Přihlaste se k github.com.
Na domovské stránce GitHubu vyberte tlačítko Nový vedle slova Úložiště.
Pojmenujte úložiště, například Blink, a vyberte Vytvořit úložiště.
V části Rychlé nastavení – pokud jste to udělali dříve, zkopírujte adresu URL HTTPS pro své úložiště.
Na příkazovém řádku naklonujte nové úložiště do místní plochy následujícím způsobem:
```
git clone <repository-url>
```
Mělo by se zobrazit upozornění, že jste naklonovali prázdné úložiště.

Vytvoření nového projektu Blink ve klonu

Otevřete Visual Studio Code a vytvořte nový projekt následujícím způsobem:

Výběr palety>příkazů Zobrazit>v Azure Sphere: Vygenerujte nový projekt.
V části Vybrat šablonu vyberte Blink.
V dialogovém okně Vybrat složku zadejte složku, ve které chcete vytvořit nový projekt. (To může být kdekoli – obsah této složky zkopírujete do dříve vytvořeného úložiště GitHub.)
Zadejte název projektu, který odpovídá názvu úložiště GitHub, například Blink, a stiskněte Enter.
Zkopírujte soubory projektu Azure Sphere (včetně všech podsložek, jako jsou .vscode a HardwareDefinitions), do místního klonu, potvrzení a nasdílení změn. Pak můžete odstranit složku projektu vytvořenou v této části, protože všechno bude v úložišti GitHub.

Nastavení složky .devcontainer

V adresáři nejvyšší úrovně úložiště GitHub vytvořte složku s názvem .devcontainer. V této složce vytvořte soubor s názvem devcontainer.json s následujícím obsahem:

{
    "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"
    ]
}

Dále ve složce .devcontainer vytvořte soubor s názvem Dockerfile s následujícím obsahem:

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" ]

Počáteční FROM řádek určuje standardní image Dockeru Azure Sphere jako základní vývojový kontejner a druhá říká, že se má tento základní kontejner použít jako prostředí sestavení. Řádek COPY zkopíruje obsah úložiště do adresáře /src/ kontejneru. Určuje WORKDIR adresář sestavení. Příkaz RUN poskytuje příkaz CMake pro vygenerování souborů sestavení. Nakonec určí, ENTRYPOINT že nindžové by měli být vyvolána k skutečnému sestavení aplikace.

Potvrďte změny do projektu GitHubu a nasdílejte změny.

Instalace rozšíření GitHub Codespaces

Instalace rozšíření GitHub Codespaces:

Otevřete složku úložiště GitHub v editoru Visual Studio Code, pokud ještě není.
Otevřete rozšíření z panelu aktivit editoru Visual Studio Code.
Vyhledejte "GitHub Codespaces" a nainstalujte rozšíření GitHub Codespaces.

Vytvoření prostoru kódu

Výběr možnosti Zobrazit>paletu>příkazů Codespaces: Vytvořit nový codespace.
V rozevíracím seznamu úložišť vyberte Blink. Pokud se vaše úložiště v rozevíracím seznamu nezobrazí, můžete jeho název zadat do textového pole nad seznamem.
V rozevíracím seznamu větví vyberte odpovídající větve.

Záhlaví editoru Visual Studio Code se změní, aby se zobrazilo, že upravujete v Codespaces. Pokud otevřete kartu Rozšíření v levém navigačním panelu, zobrazí se obě rozšíření nainstalovaná místně i rozšíření nainstalovaná ve vzdáleném kontejneru.

Sestavení a ladění projektu

Stisknutím klávesy F5 nebo výběrem možnosti Spustit>ladění sestavte projekt a začněte ladit. Aplikace se sestaví a načte do zařízení jako obvykle. Pokud jste v kódu nastavili zarážku, aplikace se spustí, dokud nedosáhnete zarážky. K procházení kódu můžete použít obvyklé ladicí příkazy. Další podrobnosti najdete v tématu Ladění v dokumentaci editoru Visual Studio Code.

Po dokončení ladění stiskněte Shift+F5 nebo ikonu Zastavit . Pokud chcete kódspace zavřít, vyberte Zobrazit>paletu>příkazů Codespaces: Zastavit aktuální codespace.

Sdílet prostřednictvím