Einrichten von CI/CD-Pipelines v4

  • Artikel

Wichtig

Wir haben die Erweiterung Teams Toolkit v5 in Visual Studio Code eingeführt. Diese Version wird mit vielen neuen App-Entwicklungsfeatures bereitgestellt. Es wird empfohlen, teams Toolkit v5 zum Erstellen Ihrer Teams-App zu verwenden.

Die Teams Toolkit v4-Erweiterung wird bald veraltet sein.

TeamsFx hilft bei der Automatisierung Ihres Entwicklungsworkflows beim Erstellen von Teams-Anwendungen. Im Folgenden finden Sie die Tools und Vorlagen, mit denen Sie CI/CD-Pipelines einrichten, Workflowvorlagen erstellen und CI/CD-Workflows mit GitHub, Azure DevOps, Jenkins und anderen Plattformen anpassen können. Um Ressourcen bereitzustellen, können Sie Azure-Dienstprinzipale erstellen und die Microsoft Teams-App über das Microsoft Teams-Entwicklerportal veröffentlichen. Um eine Microsoft Teams-App manuell zu veröffentlichen, können Sie das Entwicklerportal für Microsoft Teams nutzen.

Tools und Vorlagen Beschreibung
TeamsFx CLI-Action GitHub-Aktion, die in teamsFx CLI integriert ist.
Microsoft Teams-Toolkit in Visual Studio Code Visual Studio Code-Erweiterung, die Sie bei der Entwicklung von Teams-Apps und Automatisierungsworkflows für GitHub, Azure DevOps und Jenkins unterstützt.
TeamsFx CLI Kommandozeilen-Tool, das Sie bei der Entwicklung von Teams-Apps und Automatisierungsworkflows für GitHub, Azure DevOps und Jenkins unterstützt.
script-ci-template.sh und script-cd-template.sh Skriptvorlagen für die Automatisierung außerhalb von GitHub, Azure DevOps oder Jenkins.

Einrichten von Pipelines

Sie können Pipelines mit den folgenden Plattformen einrichten:

  1. Einrichten von Pipelines mit GitHub
  2. Einrichten von Pipelines mit Azure DevOps
  3. Einrichten von Pipelines mit Jenkins
  4. Einrichten von Pipelines für andere Plattformen

Einrichten von Pipelines mit GitHub

So richten Sie Pipelines mit GitHub für CI/CD ein:

  • Erstellen von Workflowvorlagen.

    • Visual Studio Code
    • TeamsFx CLI

  • Anpassen des CI/CD-Workflows.

Erstellen von Workflowvorlagen

Sie können die folgenden Workflowvorlagen mit GitHub erstellen:

Microsoft Teams-Toolkit in Visual Studio Code

  1. Erstellen Sie eine neue Microsoft Teams-App mit dem Microsoft Teams-Toolkit.

  2. Wählen Sie im linken Bereich das Symbol Teams Toolkit aus.

  3. Wählen Sie Features hinzufügen aus.

    Hinzufügen von Features

  4. Wählen Sie CI/CD-Workflows hinzufügen aus.

    Auswählen des CI/CD-Workflows

  5. Wählen Sie in der Eingabeaufforderung eine Umgebung aus.

  6. Wählen Sie GitHub als CI/CD-Anbieter aus.

  7. Wählen Sie aus diesen Optionen mindestens eine Vorlage aus: CI, CD, Bereitstellung oder Veröffentlichen in Microsoft Teams.

  8. Öffnen Sie die Vorlage, und passen Sie die Workflows an, die in Ihre Szenarien passen.

  9. Folgen Sie den README-Dateien unter.github/workflows, um den Workflow in GitHub einzurichten.

TeamsFx CLI

  1. Geben Sie cd in Ihr Microsoft Teams-App-Projektverzeichnis ein.
  2. Geben Sie den Befehl teamsfx add cicd ein, um den interaktiven Befehlsprozess zu starten.
  3. Wählen Sie in der Eingabeaufforderung eine Umgebung aus.
  4. Wählen Sie GitHub als CI/CD-Anbieter aus.
  5. Wählen Sie aus diesen Optionen mindestens eine Vorlage aus: CI, CD, Bereitstellung oder Veröffentlichen in Microsoft Teams.
  6. Öffnen Sie die Vorlage, und passen Sie die Workflows an, die in Ihre Szenarien passen.
  7. Folgen Sie den README-Dateien unter.github/workflows, um den Workflow in GitHub einzurichten.

Hinweis

Wenn Sie zusätzliche Workflowvorlagen hinzufügen müssen, können Sie das gleiche Verfahren zum Erstellen von Workflowvorlagen in Visual Studio Code oder TeamsFx CLI ausführen.

Anpassen des CI/CD-Workflows

Sie können die Testskripts zum Anpassen des CI/CD-Workflows ändern oder entfernen:

  1. Standardmäßig wird der CD-Workflow ausgelöst, wenn neue Commits für die main-Verzweigung vorgenommen werden.
  2. Ändern Sie bei Bedarf die Buildskripts.
  3. Entfernen Sie bei Bedarf die Testskripts.

Einrichten von Pipelines mit Azure DevOps

So richten Sie Pipelines mit Azure DevOps für CI/CD ein:

  • Erstellen von Workflowvorlagen.

    • Visual Studio Code
    • TeamsFx CLI

  • Anpassen des CI/CD-Workflows.

Erstellen von Workflowvorlagen

Sie können die folgenden Workflowvorlagen mit Azure DevOps erstellen:

Microsoft Teams-Toolkit in Visual Studio Code

  1. Erstellen Sie eine neue Microsoft Teams-App mit dem Microsoft Teams-Toolkit.
  2. Wählen Sie im linken Bereich das Symbol Teams Toolkit aus.
  3. Wählen Sie CI/CD-Workflows hinzufügen aus.
  4. Wählen Sie in der Eingabeaufforderung eine Umgebung aus.
  5. Wählen Sie Azure DevOps als CI/CD-Anbieter aus.
  6. Wählen Sie aus diesen Optionen mindestens eine Vorlage aus: CI, CD, Bereitstellung und Veröffentlichen in Microsoft Teams.
  7. Öffnen Sie die Vorlage, und passen Sie die Workflows an, die in Ihre Szenarien passen.
  8. Folgen Sie den README-Dateien unter.azure/pipelines, um den Workflow in Azure DevOps einzurichten.

TeamsFx CLI

  1. Geben Sie cd in Ihr Microsoft Teams-App-Projektverzeichnis ein.
  2. Geben Sie den Befehl teamsfx add cicd ein, um den interaktiven Befehlsprozess zu starten.
  3. Wählen Sie in der Eingabeaufforderung eine Umgebung aus.
  4. Wählen Sie Azure DevOps als CI/CD-Anbieter aus.
  5. Wählen Sie aus diesen Optionen mindestens eine Vorlage aus: CI, CD, Bereitstellung oder Veröffentlichen in Microsoft Teams.
  6. Öffnen Sie die Vorlage, und passen Sie die Workflows an, die in Ihre Szenarien passen.
  7. Folgen Sie den README-Dateien unter.azure/pipelines, um den Workflow in Azure DevOps einzurichten.

Hinweis

Wenn Sie zusätzliche Workflowvorlagen hinzufügen müssen, können Sie das gleiche Verfahren zum Erstellen von Workflowvorlagen in Visual Studio Code oder TeamsFx CLI ausführen.

Anpassen des CI-Workflows

Sie können die folgenden Änderungen an der Skript- oder Workflowdefinition vornehmen:

  1. Verwenden Sie das npm-Buildskript, oder passen Sie die Art der Erstellung im Automatisierungscode an.
  2. Verwenden Sie npm test script, das bei Erfolg Null zurückgibt, und ändern Sie die Testbefehle.

Anpassen des CD-Workflows

Sie können die folgenden Änderungen an der Skript- oder Workflowdefinition vornehmen:

  1. Stellen Sie sicher, dass Sie ein npm-Build-Skript haben oder passen Sie die Art und Weise der Erstellung im Automatisierungscode an.
  2. Stellen Sie sicher, dass Sie ein npm-Testskript haben, das bei Erfolg Null zurückgibt oder ändern Sie die Testbefehle.

Einrichten von Pipelines mit Jenkins

So richten Sie Pipelines mit Jenkins für CI/CD ein:

  • Erstellen von Workflowvorlagen.

    • Visual Studio Code
    • TeamsFx CLI

  • Anpassen des CI/CD-Workflows.

Erstellen von Workflowvorlagen

Sie können die folgenden Workflowvorlagen mit Jenkins erstellen:

Microsoft Teams-Toolkit in Visual Studio Code

  1. Erstellen Sie eine neue Microsoft Teams-App mit dem Microsoft Teams-Toolkit.
  2. Wählen Sie im linken Bereich das Symbol Teams Toolkit aus.
  3. Wählen Sie CI/CD-Workflows hinzufügen aus.
  4. Wählen Sie in der Eingabeaufforderung eine Umgebung aus.
  5. Wählen Sie Jenkins als CI/CD-Anbieter aus.
  6. Wählen Sie aus diesen Optionen mindestens eine Vorlage aus: CI, CD, Bereitstellung oder Veröffentlichen in Microsoft Teams.
  7. Öffnen Sie die Vorlage, und passen Sie die Workflows an, die in Ihre Szenarien passen.
  8. Folgen Sie den README-Dateien unter.jenkins/pipelines, um den Workflow mit Jenkins einzurichten.

TeamsFx CLI

  1. Geben Sie cd in Ihr Microsoft Teams-App-Projektverzeichnis ein.
  2. Geben Sie den Befehl teamsfx add cicd ein, um den interaktiven Befehlsprozess zu starten.
  3. Wählen Sie in der Eingabeaufforderung eine Umgebung aus.
  4. Wählen Sie Jenkins als CI/CD-Anbieter aus.
  5. Wählen Sie aus diesen Optionen mindestens eine Vorlage aus: CI, CD, Bereitstellung oder Veröffentlichen in Microsoft Teams.
  6. Öffnen Sie die Vorlage, und passen Sie die Workflows an, die in Ihre Szenarien passen.
  7. Folgen Sie den README-Dateien unter.jenkins/pipelines, um den Workflow mit Jenkins einzurichten.

Hinweis

Wenn Sie zusätzliche Workflowvorlagen hinzufügen müssen, können Sie das gleiche Verfahren zum Erstellen von Workflowvorlagen in Visual Studio Code oder TeamsFx CLI ausführen.

Anpassen des CI-Workflows

Sie können die folgenden Änderungen an Ihrem Projekt vornehmen:

  1. Ändern Sie die Art, wie der CI-Fluss ausgelöst wird. Standardmäßig werden die Trigger von pollSCM verwendet, wenn eine neue Änderung per Push in die Dev-Verzweigung verschoben wird.
  2. Stellen Sie sicher, dass Sie ein npm-Build-Skript haben oder passen Sie die Art und Weise der Erstellung im Automatisierungscode an.
  3. Stellen Sie sicher, dass Sie ein npm-Testskript haben, das bei Erfolg Null zurückgibt oder ändern Sie die Testbefehle.

Anpassen des CD-Workflows

Führen Sie die folgenden Schritte aus, um die CD-Pipeline anzupassen:

  1. Ändern Sie den CD-Fluss. Standardmäßig werden die Trigger von pollSCM verwendet, wenn eine neue Änderung per Push in die main-Verzweigung verschoben wird.
  2. Ändern Sie bei Bedarf die Buildskripts.
  3. Entfernen Sie die Testskripts, wenn Sie keine Tests haben.

Einrichten von Pipelines für andere Plattformen

Sie können den aufgeführten vordefinierten Bash-Beispielskripts folgen, um CI/CD-Pipelines auf den anderen Plattformen zu erstellen und anzupassen:

Die Skripts basieren auf einem plattformübergreifenden TeamsFx-Befehlszeilentool: TeamsFx CLI. Sie können es mit npm install -g @microsoft/teamsfx-cli installieren und der Dokumentation folgen, um die Skripts anzupassen.

Hinweis

  • Um die Ausführung von @microsoft/teamsfx-cli im CI-Modus zu ermöglichen, aktivieren Sie CI_ENABLED durch export CI_ENABLED=true. Im CI-Modus ist @microsoft/teamsfx-cli für CI/CD geeignet.
  • Um die Ausführung von @microsoft/teamsfx-cli im nicht interaktiven Modus zu ermöglichen, legen Sie eine globale Konfiguration mit folgendem Befehl fest: teamsfx config set -g interactive false. Im nicht interaktiven Modus fordert @microsoft/teamsfx-cli keine Eingaben an..

Stellen Sie sicher, dass die Azure- und Microsoft 365-Anmeldeinformationen in Ihren Umgebungsvariablen sicher eingerichtet wurden. Wenn Sie zum Beispiel GitHub als Quellcode-Repository verwenden, lesen Sie bitteGitHub Secrets.

Bereitstellen von Ressourcen

Um Ressourcen für Azure innerhalb von CI/CD bereitzustellen, müssen Sie einen Azure-Dienstprinzipal erstellen und verwenden.

Führen Sie die folgenden Schritte aus, um Azure-Dienstprinzipale zu erstellen:

  1. Registrieren Sie eine Microsoft Azure Active Directory (Azure AD)-Anwendung in einem einzelnen Einzelmandanten.
  2. Weisen Sie Ihrer Azure AD-Anwendung eine Rolle zu, um auf Ihr Azure-Abonnement zuzugreifen. Die Rolle Contributor wird empfohlen.
  3. Erstellen Sie ein neues Azure AD-Anwendungsgeheimnis.

Tipp

Speichern Sie Ihre Mandanten-ID, Anwendungs-ID (AZURE_SERVICE_PRINCIPAL_NAME) und den geheimen Schlüssel (AZURE_SERVICE_PRINCIPAL_PASSWORD) für die zukünftige Verwendung.

Weitere Informationen finden Sie in den Richtlinien für Azure-Dienstprinzipale. Es folgen die drei Möglichkeiten zum Erstellen von Dienstprinzipalen:

Veröffentlichen einer Microsoft Teams-App mit dem Microsoft Teams-Entwicklerportal

Wenn Änderungen an der Manifestdatei der Microsoft Teams-App vorliegen, können Sie das Manifest aktualisieren und die Microsoft Teams-App erneut veröffentlichen. Um eine Microsoft Teams-App manuell zu veröffentlichen, können Sie das Entwicklerportal für Microsoft Teams nutzen.

Führen Sie die folgenden Schritte aus, um Ihre App zu veröffentlichen:

  1. Melden Sie sich beim Entwicklerportal für Microsoft Teams mit dem entsprechenden Konto an.
  2. Importieren Sie Ihr App-Paket in ZIP, und wählen Sie App>importieren App>ersetzen aus.
  3. Wählen Sie die Ziel-App in der App-Liste aus.
  4. Veröffentlichen Sie Ihre App, und wählen Sie aus Publish -> Publish to your org.

Siehe auch