Konfigurieren einer Pipeline und Pushupdates

In diesem Artikel erfahren Sie, wie Sie die Azure Developer CLI (azd) verwenden, um Vorlagenänderungen über eine CI/CD-Pipeline wie GitHub-Aktionen oder Azure DevOps zu übertragen. In diesem Beispiel verwenden Sie die React Web App mit Node.js API und MongoDB auf Azure-Vorlage , aber Sie können die in diesem Artikel beschriebenen Prinzipien auf eine der Azure Developer CLI-Vorlagen anwenden.

Hinweis

Der azd pipeline config Befehl befindet sich noch in der Betaversion. Weitere Informationen zur Unterstützung von Alpha- und Betafeatures finden Sie auf der Seite "Featureversionsverwaltung" und "Releasestrategie ".

Voraussetzungen

• Installieren Sie die Azure Developer CLI.
• Stellen Sie die vorlage Node.js bereit.
• Installation von Visual Studio Code.

Alle azd Vorlagen enthalten eine standardmäßige GitHub-Aktionen- und Azure DevOps-Pipelinekonfigurationsdatei, azure-dev.ymldie zum Einrichten von CI/CD erforderlich ist. Diese Konfigurationsdatei stellt Ihre Azure-Ressourcen bereit und stellt Ihren Code im Standard Branch bereit. Sie finden azure-dev.yml:

• Für GitHub-Aktionen: im .github/workflow Verzeichnis.
• Für Azure DevOps: im .azdo/pipelines Verzeichnis.

Um eine CI/CD-Pipeline zu konfigurieren, verwenden Sie den azd pipeline config Befehl, der die folgenden Aufgaben behandelt:

• Erstellt und konfiguriert einen Dienstprinzipal für die App im Azure-Abonnement.
• Führt Sie durch einen Workflow, um ein GitHub-Repository zu erstellen und zu konfigurieren und ihren Projektcode darauf zu übernehmen. Sie können auch ein vorhandenes GitHub-Repository verwenden.
• Erstellt eine sichere Verbindung zwischen Azure und Ihrem Repository mithilfe von GitHub-Geheimschlüsseln.
• Führt die GitHub-Aktion aus, wenn Sie die Workflowdatei einchecken.

Zur genaueren Kontrolle über diesen Prozess können Sie auch eine Pipeline manuell konfigurieren.

Alle Vorlagen enthalten eine standardmäßige GitHub-Aktionen- und Azure DevOps-Pipelinekonfigurationsdatei namens azure-dev.yml. Diese Konfigurationsdatei stellt Ihre Azure-Ressourcen bereit und stellt Ihren Code im Standard Branch bereit. Sie finden azure-dev.yml:

• Für GitHub-Aktionen: im .github/workflow Verzeichnis.
• Für Azure DevOps: im .azdo/pipelines Verzeichnis.

Sie können die Konfigurationsdatei entsprechend Ihren Anforderungen verwenden oder ändern.

Wählen Sie Ihren bevorzugten Pipelineanbieter aus, um den Vorgang fortzusetzen:

GitHub-Aktionen

Autorisieren von GitHub für die Bereitstellung in Azure

Zum Konfigurieren des Workflows müssen Sie GitHub die Berechtigung erteilen, Azure in Ihrem Namen bereitzustellen. Autorisieren Sie GitHub, indem Sie einen Azure-Dienstprinzipal erstellen, der in einem GitHub-Geheimnis namens AZURE_CREDENTIALS gespeichert wird.

1. Führen Sie den folgenden Befehl aus, um den Azure-Dienstprinzipal zu erstellen und die Pipeline zu konfigurieren:

   azd pipeline config
   

   Mit diesem Befehl wird auch ein privates GitHub-Repository erstellt und Code an das neue Repository übertragen.

   Hinweis

   Verwendet standardmäßig azd pipeline config OpenID-Verbinden (OIDC), die als Verbundanmeldeinformationen bezeichnet werden. Wenn Sie OIDC nicht verwenden möchten, führen Sie azd pipeline config --auth-type client-credentials aus.

   OIDC/Verbundanmeldeinformationen werden für Terraform nicht unterstützt.

   Erfahren Sie mehr über die Unterstützung von OIDC in azd.

2. Geben Sie die angeforderten GitHub-Informationen an.

3. Geben Sie an y, wenn Sie aufgefordert werden, die lokalen Änderungen zu übernehmen und zu pushen, um eine neue Ausführung von GitHub-Aktionen zu starten.

4. Zeigen Sie im Terminalfenster die Ergebnisse des azd pipeline config Befehls an. Der azd pipeline config Befehl gibt den GitHub-Repositorynamen für Ihr Projekt aus.

5. Öffnen Sie mit Ihrem Browser das GitHub-Repository für Ihr Projekt.

6. Wählen Sie "Aktionen" aus, um den ausgeführten Workflow anzuzeigen.

   

Vornehmen und Pushen einer Codeänderung

1. Öffnen header.tsxSie im Verzeichnis des /src/web/src/layout Projekts .

2. Suchen Sie die Zeile <Text variant="xLarge">ToDo</Text>.

3. Ändern Sie das Literal ToDo in myTodo.

4. Speichern Sie die Datei .

5. Committen Sie die Änderung. Beim Commit der Änderung wird die GitHub Action-Pipeline gestartet, um das Update bereitzustellen.

   

6. Öffnen Sie mit Ihrem Browser das GitHub-Repository Ihres Projekts, um beides anzuzeigen:

   • Ihr Commit
   • Der Commit von GitHub-Aktionen, die eingerichtet werden.

   

7. Wählen Sie "Aktionen" aus, um die im Workflow wiedergegebene Testaktualisierung anzuzeigen.

   

8. Besuchen Sie die Web-Frontend-URL, um das Update zu prüfen.

azd als GitHub-Aktion

Als GitHub-Aktion hinzufügenazd. Diese Aktion wird installiert azd. Um sie zu verwenden, können Sie Folgendes hinzufügen:.github\workflows\azure-dev.yml

on: [push]

jobs:
   build:
      runs-on: ubuntu-latest
      steps:
         - name: Install azd
         uses: Azure/setup-azd@v0.1.0

Azure DevOps

Hinweis

Wenn Sie Azure DevOps für eine Java-Vorlage unter Windows verwenden, lesen Sie den entsprechenden Abschnitt im Handbuch zur Problembehandlung.

Erstellen oder Verwenden einer vorhandenen Azure DevOps-Organisation

Um eine Pipeline in Azure DevOps auszuführen, benötigen Sie eine Azure DevOps-Organisation. Sie können eine erstellen, indem Sie das Azure DevOps-Portal verwenden: https://dev.azure.com.

Erstellen eines persönlichen Zugriffstokens

Die Azure Developer CLI basiert auf einem Azure DevOps Personal Access Token (PAT), um ein Azure DevOps-Projekt zu konfigurieren. Erstellen Sie ein neues Azure DevOps PAT.

Legen Sie beim Erstellen Ihres PAT die folgenden Bereiche fest:

• Agentpools (lesen, verwalten)
• Build (Lesen und Ausführen)
• Code (vollständig)
• Projekt und Team (Lesen, Schreiben und Verwalten)
• Release (Lesen, Schreiben, Ausführen und Verwalten)
• Dienst-Verbinden ions (Lesen, Abfragen und Verwalten)

Aufrufen des Pipeline-Konfigurationsbefehls

1. (Optional) Um den Standardpipelineanbieter von GitHub Actions auf Azure DevOps zu aktualisieren, bearbeiten Sie azure.yaml sich im Stammverzeichnis Ihres Projekts, und fügen Sie Folgendes hinzu:

   pipeline: 
      provider: azdo 
   

2. Führen Sie den folgenden Befehl aus, um ein Azure DevOps-Projekt und -Repository mit einer Bereitstellungspipeline zu konfigurieren.

   azd pipeline config --provider azdo
   

   Wenn Sie das Konfigurationsupdate in Schritt 1 ausgeführt haben, können Sie die --provider Kennzeichnung weglassen:

   azd pipeline config
   

Hinweis

In Azure DevOps wird standardmäßig azd pipeline config verwendet client-credentials. OIDC/Verbundanmeldeinformationen werden für Azure DevOps nicht unterstützt.

Erfahren Sie mehr über die Unterstützung von OIDC in azd.

1. Geben Sie Ihre Antworten auf die folgenden Eingabeaufforderungen an:

   Persönliches Zugriffstoken (PAT)

   • Kopieren/einfügen Sie Ihren PAT.

   • Exportieren Sie Ihre PAT als Systemumgebung, indem Sie den folgenden Befehl ausführen. Andernfalls werden Sie jedes Mal aufgefordert, wenn Sie eine Azure-Pipeline einrichten:

     export AZURE_DEVOPS_EXT_PAT=<PAT>
     

   Bitte geben Sie einen Namen der Azure DevOps-Organisation ein.

   Geben Sie Ihre AzDo-Organisation ein. Sobald Sie die EINGABETASTE erreicht haben, AZURE_DEVOPS_ORG_NAME="<your Azure DevOps Org Name>" wird der env-Datei für die aktuelle Umgebung automatisch hinzugefügt.

   Ein Remotename mit dem Namen "origin" wurde nicht gefunden. Möchten Sie eins konfigurieren?

   Ja

   Wie möchten Sie Ihr Projekt konfigurieren?

   Erstellen eines neuen Azure DevOps-Projekts

   Geben Sie den Namen für Ihr neues Azure DevOps-Projekt ODER Treffer ein, um diesen Namen zu verwenden: ( {default name} )

   Wählen Sie die EINGABETASTE aus, oder erstellen Sie einen eindeutigen Projektnamen.

   Möchten Sie einen Commit ausführen und Ihre lokalen Änderungen übertragen, um die konfigurierte CI-Pipeline zu starten?

   Ja

2. Navigieren Sie zu Ihrem Azure DevOps-Portal (https://dev.azure.com), um Ihr Projekt zu finden und den Build zu überprüfen.

Vornehmen und Pushen einer Codeänderung

1. Öffnen header.tsxSie im Verzeichnis des /src/web/src/layout Projekts .

2. Suchen Sie die Zeile <Text variant="xLarge">ToDo</Text>.

3. Ändern Sie das Literal ToDo in myTodo.

4. Speichern Sie die Datei .

5. Erstellen Sie eine Verzweigung, und übernehmen Sie ihre Änderung. Die main Verzweigung in Azure DevOps ist vor dem direkten Pushen geschützt. Sie müssen die Änderungen aus einer neuen Verzweigung pushen und einen Pull Request in Azure DevOps erstellen. Die Pullanforderung startet die Pipeline automatisch und verhindert das Zusammenführen, wenn die Pipeline fehlschlägt.

6. Genehmigen Sie Ihre Pullanforderung, und führen Sie sie zusammen, um die Pipeline erneut zu starten.

   

7. Öffnen Sie mit Ihrem Browser das Repository Ihres Projekts, um beides anzuzeigen:

   • Ihr Commit
   • Azure-Pipeline

   

8. Besuchen Sie die Web-Frontend-URL, um das Update zu prüfen.

azd als Azure DevOps-Aufgabe

Als Azure DevOps-Aufgabe hinzufügenazd. Diese Aufgabe wird installiert azd. Um sie zu verwenden, können Sie Folgendes hinzufügen:.azdo\pipelines\azure-dev.yml

trigger:
   - main
   - branch

pool:
   vmImage: ubuntu-latest
   # vmImage: windows-latest

steps:
   - task: setup-azd@0
   displayName: Install azd

Bereinigen von Ressourcen

Wenn Sie die in diesem Artikel erstellten Azure-Ressourcen nicht mehr benötigen, führen Sie den folgenden Befehl aus:

azd down

Hilfe anfordern

Informationen zum Ablegen eines Fehlers, Anfordern von Hilfe oder Vorschlagen eines neuen Features für die Azure Developer CLI finden Sie auf der Seite "Problembehandlung und Support ".

Nächste Schritte

Überwachen Ihrer App mithilfe der Azure Developer CLI (azd)