Veröffentlichen einer Erweiterung

Nachdem Sie eine Azure Developer CLI()-Erweiterung erstelltazd haben, packen Und veröffentlichen Sie sie in einer Registrierung, damit andere sie installieren können. In diesem Artikel erfahren Sie, wie Sie die Beispielerweiterung Contoso Resource Tagger aus der Schnellstartanleitung "Erstellen einer Beispielerweiterung" veröffentlichen. Sie können die gleichen Schritte auf jede Erweiterung anwenden.

Note

Das Erweiterungsframework azd ist allgemein verfügbar. Einzelne Erweiterungen oder Funktionen verfügen möglicherweise über einen eigenen Vorschaustatus.

Auswählen einer Registrierung

azd kann Erweiterungen aus der offiziellen Registrierung, benutzerdefinierten URL-basierten Registrierungsmanifesten, dateibasierten Registrierungsmanifesten und portablen Bundledateien auflösen. Wählen Sie den Verteilungsansatz aus, der der Installation Ihrer Erweiterung durch Benutzer entspricht:

  • Offizielles Register: Das Register, das mit azd ausgeliefert wird. Um hier zu veröffentlichen, reichen Sie einen Pull Request in einem Fork des azure/azure-dev-Repositorys ein.
  • Benutzerdefinierte URL-basierte Registrierung: Ein Remoteregistrierungsmanifest, das Ihr Team für öffentliche oder private Verteilung hosten soll.
  • Dateibasierte Registrierung: Ein lokales Registrierungsmanifest für Entwicklung, Tests, Offlineverwendung oder private Verteilung.
  • Entwicklungs- oder Nachtregistrierung: Eine Opt-In-Registrierung für laufende Arbeit oder automatisch integrierte Erstanbietererweiterungen. Erweiterungen in der Dev-Registrierung sind nicht signiert, nicht durch Azure-Support abgedeckt und können ohne Vorheriges geändert oder entfernt werden.
  • Portables Bündel: Ein eigenständiges .zip Paket, das Benutzer direkt aus einem lokalen Pfad oder einer HTTPS-URL installieren, ohne eine Registrierungsquelle hinzuzufügen.

In diesem Artikel wird die Entwicklungsregistrierung verwendet, um die Veröffentlichung in einer freigegebenen Testquelle zu veranschaulichen. Ausführliche Informationen zur Quell- und Versionsauflösung finden Sie in der Referenz zum Erweiterungsframework.

Voraussetzungen

  • Eine fertiggestellte Erweiterung aus dem Schnellstart „Erstellen einer Beispielerweiterung“.
  • Die azd Erweiterung für Entwickler (microsoft.azd.extensions), die die azd x Befehle zum Packen und Veröffentlichen bereitstellt. Wenn Sie die Schnellstartanleitung abgeschlossen haben, ist sie bereits installiert. Andernfalls führen Sie azd extension install microsoft.azd.extensions aus.
  • Ein GitHub-Konto und ein Repository zum Hosten der Releaseartefakte.
  • Ein persönliches GitHub-Zugriffstoken (PAT) mit der Berechtigung repo. Der Releasebefehl verwendet dieses Token, um GitHub Versionen zu erstellen und Artefakte hochzuladen. Weitere Informationen finden Sie unter Verwalten Ihrer persönlichen Zugriffstoken.

Aktualisieren der Version und des Änderungsprotokolls

Aktualisieren Sie vor der Veröffentlichung die Version und dokumentieren Sie Ihre Änderungen:

  1. Aktualisieren Sie die version-Eigenschaft in extension.yaml gemäß der semantischen Versionierung. Erhöhen Sie die Haupt-, Neben- oder Patchnummer je nach Art der Änderung.

  2. Aktualisieren Sie CHANGELOG.md mit den wesentlichen Änderungen für diese Version. azd verwendet das Änderungsprotokoll zum Erstellen von Versionshinweisen.

Erweiterung verpacken

Verwenden Sie den azd x pack Befehl, um plattformspezifische Binärdateien zu erstellen und die Erweiterung zu verpacken:

azd x pack

Der Befehl erstellt Artefakte für jede unterstützte Plattform in Ihrem Ausgabeverzeichnis. azd x release lädt diese Artefakte hoch und azd x publish aktualisiert die Registrierungsmetadaten. Beim Packen werden auch Momentaufnahmentests ausgeführt, um zu überprüfen, ob sich die Erweiterung vor der Veröffentlichung wie erwartet verhält.

Wenn Sie eine Erweiterung direkt verteilen möchten, anstatt sie über eine Registrierung zu veröffentlichen, erstellen Sie ein eigenständiges Bundle mit azd x pack --bundle. Das Bundle ist ein portables .zip Paket, das die Registrierungsmetadaten und Artefakte enthält, die für die Installation aus einem Dateipfad oder einer HTTPS-URL erforderlich sind.

Geben Sie die Erweiterung frei

Verwenden Sie den azd x release Befehl, um eine GitHub Freigabe zu erstellen und die verpackten Artefakte hochzuladen. Stellen Sie Ihren GitHub PAT bereit, damit der Befehl die Version erstellen kann:

azd x release

Der Befehl erstellt eine Version in Ihrem GitHub-Repository, lädt die verpackten Binärdateien hoch und generiert Versionshinweise aus Ihrem Änderungsprotokoll. Die registrierungsbasierte Veröffentlichung verwendet diese Releaseartefakte als herunterladbare Erweiterungspakete. Für die Direkte Bundleverteilung ist dieser Releaseschritt nicht erforderlich, es sei denn, Sie möchten das Bundle in GitHub hosten.

Tip

Speichern Sie Ihre GitHub PAT in einer Umgebungsvariable, anstatt sie an die Befehlszeile zu übergeben. Rufen Sie die Befehlshilfe auf, indem Sie azd x release --help ausführen, um die unterstützten Authentifizierungsoptionen anzuzeigen.

In die Registry veröffentlichen

Verwenden Sie den azd x publish Befehl, um den Eintrag Ihrer Erweiterung in der Erweiterungsregistrierung hinzuzufügen oder zu aktualisieren:

azd x publish

Der Befehl aktualisiert die Registrierungsmetadaten, damit Benutzer Ihre Erweiterung aus der Entwicklungsregistrierung ermitteln und installieren können. Dieser Schritt unterscheidet sich von dem lokalen Veröffentlichungsvorgang, den azd x init im Schnellstart durchführt und bei dem die Erweiterung nur bei einer lokalen Quelle auf Ihrem Computer registriert wird. Durch Ausführen azd x publish von Updates wird die Registrierung für die gemeinsame Entwicklung aktualisiert, damit andere Benutzer Ihre Erweiterung installieren können.

Installieren und Überprüfen

Überprüfen Sie nach der Veröffentlichung, ob andere Personen Ihre Erweiterung aus der Entwicklungsregistrierung installieren können:

  1. Stellen Sie sicher, dass Sie die Entwicklungsregistrierung bereits hinzugefügt haben.

    azd extension source add -n dev -t url -l "https://aka.ms/azd/extensions/registry/dev"

  2. Installieren Sie die Erweiterung anhand ihrer ID.

    azd extension install contoso.azd.tagger

  3. Führen Sie einen Befehl aus, um zu bestätigen, dass die Erweiterung funktioniert.

    azd tagger show

Im offiziellen Register veröffentlichen

Um sie in der offiziellen Registrierung zu veröffentlichen, übermitteln Sie Ihre Erweiterung an das Repository azure/azure-Dev:

  1. Forken Sie das Repository azure/azure-dev.
  2. Fügen Sie den Registry-Eintrag Ihrer Erweiterung in Ihrem Fork zur offiziellen Registry-Datei hinzu.
  3. Senden Sie eine Pull-Request zur Überprüfung.

Das Azure Developer CLI-Team überprüft Einreichungen für das offizielle Register auf Qualität und Sicherheit, bevor sie zusammengeführt werden.

Veröffentlichungsprobleme beheben

In der folgenden Tabelle sind allgemeine Veröffentlichungsprobleme und deren Lösungen aufgeführt:

Issue Resolution
Release schlägt mit einem Authentifizierungsfehler fehl Überprüfen Sie, ob Ihr GitHub PAT gültig ist und über den repo Bereich verfügt.
Snapshot-Tests schlagen bei azd x pack fehl Überprüfen Sie die Testausgabe, aktualisieren Sie Ihre Snapshots, wenn die Änderungen erwartet sind, und führen Sie den Befehl erneut aus.
Benutzer können Ihre Erweiterung nicht finden Vergewissern Sie sich, dass das Entwicklungsregister hinzugefügt wurde und dass azd x publish erfolgreich abgeschlossen wurde.
Versionskonflikt während der Veröffentlichung Erhöhen Sie das version In extension.yaml auf eine neue, nicht verwendete Version.

Verwandte Inhalte

  • Last updated on