Packen und Veröffentlichen von Erweiterungen
Azure DevOps Services | Azure DevOps Server 2022 | Azure DevOps Server 2019
Nachdem Sie Ihre Erweiterung entwickelt haben, können Sie sie packen und im Visual Studio Marketplace veröffentlichen. Der Marketplace ist ein globales Repository für private und öffentliche Erweiterungen, Integrationen und andere Angebote von Microsoft.
Hinweis
Informationen zu den Ermittlungseigenschaften, die in der Manifestdatei Ihrer Erweiterung verfügbar sind, die Benutzern hilft, Ihre Erweiterung zu entdecken und zu erfahren, finden Sie in der Erweiterungsmanifestreferenz.
Voraussetzungen
Die folgende Liste der Anforderungen muss erfüllt sein, bevor Sie auf dem Marketplace veröffentlichen.
- Installieren Sie das Erweiterungspakettool (TFX). Führen Sie
npm install -g tfx-cli
eine Eingabeaufforderung aus. - Stellen Sie sicher, dass die richtigen Berechtigungen erteilt werden, um Bilder zu verwenden, z. B. Symbole, Logos, Screenshots usw.
- Fügen Sie eine gründliche
overview.md
Datei hinzu, um Ihren Eintrag auf dem Marketplace zu beschreiben. - Fügen Sie ein Symbol für Die Erweiterung ein, das mindestens 128 x 128 Pixel groß ist.
- Wenn Sie auf Microsoft-Produkte verweisen, verwenden Sie vollständige Namen anstelle von Abkürzungen, z. B. Azure DevOps vs. AzDO oder eine andere Abkürzung.
- Vermeiden Sie die Verwendung von Markennamen im Namen Ihrer Erweiterung.
Erstellen eines Herausgebers
Alle Erweiterungen und Integrationen, einschließlich Erweiterungen von Microsoft, verfügen über einen Herausgeber. Jeder kann einen Herausgeber erstellen und Erweiterungen veröffentlichen. Sie können anderen Personen auch Zugriff auf Ihren Herausgeber gewähren, wenn ein Team die Erweiterung entwickelt.
Ein Benutzer besitzt den Herausgeber, in der Regel der Benutzer, der ihn erstellt hat. Sie können den Herausgeber auch für andere Benutzer freigeben.
Melden Sie sich beim Visual Studio Marketplace-Veröffentlichungsportal an.
Wenn Sie noch kein Mitglied eines vorhandenen Herausgebers sind, + Erstellen Sie einen Herausgeber. Geben Sie einen Namen in das Feld "Herausgebername" ein. Das Feld "ID" sollte basierend auf dem eingegebenen Namen automatisch festgelegt werden.
Hinweis
Notieren Sie sich die ID, da Sie sie in der Manifestdatei Ihrer Erweiterung festlegen müssen.
Wenn Sie nicht aufgefordert werden, einen Herausgeber zu erstellen, scrollen Sie nach unten nach unten auf der Seite, und wählen Sie "Erweiterungen veröffentlichen" unter "Verwandte Websites" aus.
- Geben Sie einen Bezeichner für Ihren Herausgeber an, z. B.:
mycompany-myteam
. Dieser Bezeichner wird als Wert für daspublisher
Attribut in der Erweiterungsmanifestdatei verwendet. - Geben Sie einen Anzeigenamen für Ihren Herausgeber an, z. B.:
My Team
- Geben Sie einen Bezeichner für Ihren Herausgeber an, z. B.:
Überprüfen Sie die Marketplace-Herausgebervereinbarung, und wählen Sie dann "Erstellen" aus.
Nachdem der Herausgeber erstellt wurde, werden Sie angewiesen, Elemente zu verwalten, aber es gibt keine Elemente.
Packen der Erweiterung
Um Ihre Erweiterung hochzuladen, müssen Sie sie als VSIX 2.0-kompatible VSIX-Datei verpacken. Microsoft bietet eine plattformübergreifende Befehlszeilenschnittstelle (CLI), um Ihre Erweiterung zu packen und zu veröffentlichen.
Öffnen Sie die Erweiterungsmanifestdatei (
vss-extension.json
), und legen Sie den Wert despublisher
Felds auf die ID Ihres Herausgebers fest. Zum Beispiel:{ ... "id": "my-first-extension", "publisher": "AnnetteNielsen", ... }
Führen Sie an einer Eingabeaufforderung den Paketbefehl des TFX-Tools aus Ihrem Erweiterungsverzeichnis aus.
npx tfx-cli extension create
Eine Meldung zeigt an, dass Ihre Erweiterung erfolgreich verpackt wurde:
=== Completed operation: create extension === - VSIX: C:\my-first-extension\AnnetteNielsen.my-first-extension-1.0.0.vsix - Extension ID: my-first-extension - Extension Version: 1.0.0 - Publisher: AnnetteNielsen
Hinweis
Die Version einer Erweiterung/Integration muss bei jedem Update erhöht werden.
Wenn Sie ihre Erweiterung/Integration im Manifest nicht erhöht haben, sollten Sie die --rev-version
Befehlszeilenoption übergeben. Dadurch wird die Patchversionsnummer Ihrer Erweiterung erhöht und die neue Version in Ihrem Manifest gespeichert.
Paketgröße überprüfen
Überprüfen Sie die Größe des Vsix, nachdem sie verpackt wurde. Wenn es größer als 50 MB ist, müssen Sie es optimieren. Lesen Sie dazu die folgenden Überlegungen:
- Deduplizieren Sie die allgemeinen Abhängigkeiten( falls vorhanden), indem Sie sie einmal im Erweiterungspaket angeben.
- Rufen Sie Dinge zur Laufzeit oder während der Installationszeit ab, anstatt sie innerhalb des Pakets bereitzustellen. Erwägen Sie die Verwendung der Tool-Installer-Lib zum Abrufen von Toolabhängigkeiten zur Laufzeit. Die Verwendung der Lib bietet Vorteile, bei denen das Tool nach Version zwischengespeichert wird, sodass private Agents nicht jeden Build herunterladen. Wir haben es zu einer Lib gemacht, damit sie außerhalb von Toolinstallationsaufgaben verwendet werden kann. Die Aufgabe funktioniert jedoch nicht in getrennten Szenarien (kein Internet), was sich in der Beschreibung /Dokumentation für die Aufgabe befinden sollte.
- Einige Benutzer haben Erfolg mit WebPack, um ihre Abhängigkeiten in ihren Aufgaben zu schütteln.
Veröffentlichen der Erweiterung
Nachdem Ihre Erweiterung gepackt wurde, können Sie sie unter einem Herausgeber in den Marketplace hochladen. Der publisher
in der Manifestdatei Ihrer Erweiterung angegebene Bezeichner muss mit dem Bezeichner des Herausgebers übereinstimmen, unter dem die Erweiterung hochgeladen wird.
Wählen Sie im Verwaltungsportal ihren Herausgeber im Dropdownmenü oben auf der Seite aus.
Wählen Sie "Neue Erweiterung>" in Azure DevOps aus.
Ziehen Sie die Datei, und legen Sie sie ab, oder wählen Sie sie aus, um Ihre VSIX-Datei zu finden, die Sie im vorherigen Verpackungsschritt erstellt haben, und wählen Sie dann "Hochladen" aus.
Nach der schnellen Überprüfung wird Ihre Erweiterung in der Liste der veröffentlichten Erweiterungen angezeigt. Keine Sorge, die Erweiterung ist nur für Sie sichtbar.
An diesem Punkt ist Ihre Erweiterung für keine Konten sichtbar und kann erst installiert werden, wenn Sie sie freigeben.
Hinweis
Microsoft führt einen Virenscan für jedes neue und aktualisierte Erweiterungspaket aus, das veröffentlicht wurde. Bis der Scan vollständig klar ist, veröffentlichen wir die Erweiterung nicht im Marketplace für die öffentliche Nutzung. Auf diese Weise vermeiden wir auch unangemessene oder anstößige Inhalte auf den Marketplace-Seiten.
Teilen Ihrer Erweiterung
Sie müssen Ihre Erweiterung für eine Organisation freigeben, bevor Sie sie in Azure DevOps installieren können. Führen Sie die folgenden Aufgaben aus, um eine Erweiterung zu teilen:
Wählen Sie im Marketplace-Verwaltungsportal Ihre Erweiterung aus der Liste aus, klicken Sie mit der rechten Maustaste, und wählen Sie dann je nach Erweiterung "Freigeben/Freigeben/Aufheben der Veröffentlichung aufheben".
Wählen Sie "Organisation" aus, und geben Sie dann den Namen Ihrer Organisation ein. Drücken Sie die EINGABETASTE.
Schließen Sie das Panel.
Ihre Erweiterung kann jetzt in dieser Organisation installiert werden.
Installieren Der Erweiterung
Führen Sie die folgenden Schritte aus, um Ihre freigegebene Erweiterung zu installieren.
Wählen Sie im Marketplace Ihre Erweiterung aus, um die Übersichtsseite zu öffnen.
Hinweis
Da Ihre Erweiterung privat ist, können nur Sie und jedes Mitglied der Organisation, mit der sie geteilt wird, diese Seite sehen.
Wählen Sie "Kostenlos abrufen " aus, um den Installationsprozess zu starten. Wählen Sie die Organisation aus, für die Sie die Erweiterung im Dropdownmenü freigegeben haben.
Wählen Sie Installieren aus.
Herzlichen Glückwunsch! Sie haben Ihre Erweiterung in einer Organisation installiert, und Sie können sie ausprobieren.
Probieren Sie Ihre Erweiterung aus
Wählen Sie "Zur Organisation wechseln" am Ende des Installations-Assistenten aus, um zur Startseite der Organisation zu wechseln, auf der die Erweiterung installiert wurde (
https://dev.azure.com/{organization}
).Aktualisieren Sie Ihren Browser.
Öffnen Sie Organisationseinstellungen, und wählen Sie dann "Erweiterungen" aus.
Die neue Erweiterung sollte auf der Registerkarte "Installiert " angezeigt werden.
Debuggen der Erweiterung
Um die Erweiterung mit Visual Studio oder Browser Developer Tools zu debuggen, ändern Sie das Manifest, indem Sie die baseUri
Eigenschaft hinzufügen. Diese Aktion beschleunigt die Entwicklung, ohne die Erweiterung bei jeder Änderung des Quellcodes erneut bereitstellen zu müssen.
{
...
"baseUri": "https://localhost:44300",
...
}
Wenn Sie das Manifest ändern, wird die Erweiterung von Ihrer lokalen Webserverinstanz geladen. Beispielsweise IISExpress in Visual Studio. Nachdem Sie das Manifest geändert haben, müssen Sie diese Debugerweiterung nur einmal bereitstellen und installieren.
Hinweis
Führen Sie Ihren lokalen Webserver im SSL-Modus aus, da Azure DevOps verlangt, dass die Webseite von einer sicheren Quelle bereitgestellt wird. Andernfalls wird während des Ladens der Erweiterung IFRAME eine Fehlermeldung in der Browserkonsole angezeigt.
Aktualisieren der Erweiterung
Um eine bereits veröffentlichte Erweiterung zu ändern, aktualisieren Sie sie.
Tipp
Es wird empfohlen, die Erweiterung über das Entfernen und erneutes Hochladen zu aktualisieren. Es wird außerdem empfohlen, publisher.extension
zwei Erweiterungen zu haben, z. B. und publisher.extension-dev
.
Publisher.extension
ist im Marketplace öffentlich, wo Kunden sie in ihren Azure DevOps-Organisationen installieren können. Publisher.extension-dev
wird im Marketplace privat gehalten und kann mit einer Organisation geteilt werden, die Sie besitzen und kontrollieren.
Sie müssen nicht zwei Kopien des Quellcodes der Erweiterung verwalten. Sie können zwei Manifestdateien verwalten – eine für jede Erweiterung und während der Verpackung der Erweiterung können Sie die entsprechende Manifestdatei dem tfx-cli-Tool bereitstellen. Weitere Informationen zu argumenten, die für das Tool erforderlich sind, finden Sie unter TFX-Erweiterungsbefehle.
- Wählen Sie eine Erweiterung aus der Liste der angezeigten Elemente aus.
- Klicken Sie mit der rechten Maustaste, und wählen Sie "Aktualisieren" für das
publisher.extension-dev
Beispiel aus. - Überprüfen Sie Ihre Erweiterung.
- Nehmen Sie die gleichen Aktualisierungen an der Produktionsversion vor,
publisher.extension
z. B. - Navigieren Sie zu ".vsix" für Ihre Erweiterung, und laden Sie sie hoch.
Die aktualisierte Version Ihrer Erweiterung wird automatisch auf Konten installiert, auf denen sie bereits installiert ist. Neue Konten, bei denen die Erweiterung in Zukunft installiert ist, erhalten auch die neueste Version.
Machen Sie Ihre Erweiterung öffentlich
Während Sie Ihre Erweiterung oder Integration für den Marketplace entwickeln, behalten Sie sie privat. Um Ihre Erweiterung öffentlich verfügbar zu machen, legen Sie das öffentliche Flag in Ihrem Manifest fest true
.
Qualifizierungen
Um einen öffentlichen Eintrag auf dem Marketplace zu haben, muss Ihre Integration oder Erweiterung die folgenden Qualifikationen erfüllen:
- Funktioniert mit Azure DevOps oder erweitert.
- Sie oder Ihr Unternehmen besitzen, entwickeln und werden lizenziert, um die Integration oder Erweiterung zu vertreiben und zu bewerben.
- Die Erweiterung oder Integration wird aktiv gepflegt.
Microsoft kann auch eine Demo anfordern und die für Ihren Marketplace-Eintrag geplanten Inhalte überprüfen.
Oberster Herausgeber
Das Top Publisher-Programm ist nur für Herausgeber mit Azure DevOps-Erweiterungen oder -Integrationen verfügbar. Sie gilt nicht für Herausgeber der Visual Studio-IDE- und Visual Studio Code-Erweiterung.
Das Top Publisher-Programm erkennt Herausgeber mit Engagement für ihre Kunden und den Marketplace durch vorbildliche Richtlinien, Qualität, Zuverlässigkeit und Support an. Sobald Sie ein Top Publisher sind, werden alle Ihre öffentlichen Angebote mit dem Badge "Top Publisher" angezeigt.
Die wichtigsten Publisher-Anforderungen
Das Top Publisher-Programm im Marketplace soll Ihnen helfen, Azure DevOps-Erweiterungen und -Integrationen mit Vertrauen auszuwerten oder zu erwerben. Das Top Publisher-Badge impliziert, dass der Herausgeber seine Kunden und den Marketplace durch vorbildliche Richtlinien, Qualität, Zuverlässigkeit und Support verpflichtet. Dies gilt für Herausgeber mit mindestens einer globalen Azure DevOps-Erweiterung oder -Integration und gilt nicht für Visual Studio IDE- und Visual Studio Code-Erweiterungsherausgeber.
Marketplace weist dem Herausgeber das Signal zu, nachdem er den Herausgeber sorgfältig in den folgenden Parametern überprüft hat:
- Datenschutzrichtlinie
- Lizenzierungsrichtlinie
- Supportrichtlinie
- Dokumentation
- F & A Reaktionsfähigkeit
- Bewertungen und Bewertungen für ihre Angebote
- Aktive Aufnahme und Anzahl der Installationen für ihre Angebote
- Verwalten Sie mindestens eine öffentliche Azure DevOps-Erweiterung vom Herausgeber.
- Die öffentliche Erweiterung sollte über mehr als 5000 Installationen verfügen, wobei die Anzahl der aktiven Installationen größer als 1000 ist.
Sie können eine zeitnahe Unterstützung und eine gute Gesamterfahrung erwarten, wenn Sie eine Erweiterung von einem Top Publisher erhalten. Sehen Sie sich die Angebote der Top-Herausgeber an.
Weitere Informationen zum Hinzufügen von Richtlinien zu Ihrem Angebot finden Sie im Erweiterungsmanifest.
Aktualisieren Sie Ihr Herausgeberprofil.
Über das Herausgeberprofil können Sie alle Ihre Angebote an einem Ort zusammen mit wichtigen Herausgeberinformationen präsentieren. Führen Sie die folgenden Schritte aus, um die Informationen bereitzustellen, die im Profil angezeigt werden:
a. Melden Sie sich mit dem Konto an https://marketplace.visualstudio.com/manage/publishers , mit dem Sie Ihre Angebote im Visual Studio Marketplace veröffentlichen und verwalten.
b. Wählen Sie den Herausgeber aus, und füllen Sie den Abschnitt "Informationen" auf der Registerkarte "Details" aus.
c. Speichern Sie Ihre Änderungen, und wählen Sie " Profil anzeigen" aus, um zu sehen, wie es für Verbraucher angezeigt wird. Sie können diese Profilseite verwenden, um Ihre Angebote zu evangelisieren.
Hinweis
Durch dieses Programm ist es der Herausgeber, der zertifiziert wird. Dies deckt nicht die Software oder Sicherheit ihrer Erweiterungen und Integrationen ab. Wir empfehlen Ihnen, die Sicherheitsinformationen zu beachten, wenn Sie die Angebote eines Herausgebers auswerten.
Wenn Sie eine Erweiterung von einem Top Publisher erhalten und mit Ihrer Erfahrung nicht zufrieden sind, sollten Sie sich zuerst mit dem Herausgeber beschäftigen.
Anwenden auf einen Top Publisher
- Melden Sie sich mit dem Konto an https://marketplace.visualstudio.com/manage/publishers , mit dem Sie Ihre Angebote in Marketplace veröffentlichen und verwalten.
- Wählen Sie den Herausgeber aus, und navigieren Sie zur Registerkarte "Top Publisher ". Hinweis: Sie müssen über eine oder mehrere globale Azure DevOps-Erweiterung (Server/Dienst) oder integration verfügen, damit die Registerkarte angezeigt wird.
- Wenn Sie Einen Teil der zuvor aufgeführten Anforderungen erfüllen und besitzer des Herausgebers sind, wird eine Option zum Beantragen des Programms angezeigt. Bei der Anwendung wird eine E-Mail an das Marketplace-Team gesendet, um Ihren Fall zu überprüfen. Sie antworten in weniger als 10 Werktagen mit den nächsten Schritten, klärende Fragen oder mit der Erteilung des Badges.
Das Team betrachtet wahrscheinlich andere Parameter, z. B. die aktive Aufnahme Ihrer Angebote, die Anzahl der Installationen/erste Schritte und Bewertungen und Bewertungen in Ihren Angeboten, bevor sie das Badge gewähren. Microsoft behält sich das Recht vor, das Top Publisher-Badge jederzeit zu gewähren, abzulehnen oder zu widerrufen.
Sobald ein Herausgeber ein Top Publisher ist, müssen alle zukünftigen Updates und Angebote die zuvor aufgeführten Anforderungen erfüllen.
Antworten auf Marketplace-Erweiterungsüberprüfungen
Sie können auf Rezensionen reagieren, die Kunden für Ihre Erweiterungen im Visual Studio Marketplace hinterlassen. Suchen Und wählen Sie "Antworten" neben einer Rezension aus, wenn Sie über eine der folgenden Berechtigungen verfügen: Besitzer, Ersteller oder Mitwirkender.
Sie können nur eine Antwort hinterlassen. Vermeiden Sie Rezensionen als Supportforum. Wenn Sie weitere Details benötigen, geben Sie bitte einen Supportalias an, den der Prüfer kontaktieren kann. Anschließend können Sie ihre Probleme extern beheben und Ihre Antwort mit einer Lösung aktualisieren.
Richtlinien für Herausgeberantworten
Halten Sie visual Studio Marketplace offen, einladend, respektvoll und hilfreich, damit Kunden Erweiterungen finden, testen, installieren und überprüfen können. Die Kommunikation spielt eine wichtige Rolle bei der Wahrung einer gesunden Gemeinschaft. Um diese Umgebung zu erstellen, sind hier Richtlinien für Herausgeber, die auf Kundenrezensionen reagieren. Denken Sie tief über Ihre Kundeninteraktionen nach und reflektieren Sie den Geist der Kundenerfahrung, die der Marketplace zu schaffen versucht.
- Rezensionen sind für Kundenkommentare reserviert. Verwenden Sie "Antworten ", um nur auf eine Rezension zu antworten.
- Bewertungen dienen zum Teilen von Kundenmeinungen, sodass alle Meinungen gültig sind. Kunden haben Anspruch auf ihre Meinungen, so behandeln Sie Kommentare respektvoll als Feedback ohne Debatte, Kritik oder Argument.
- Stellen Sie sicher, dass Ihre Antworten Wert hinzufügen und für die Kommentare Ihrer Kunden relevant sind.
- Konzentrieren Sie sich auf die genaue Behandlung von Fragen oder Problemen. Wenn Sie weitere Details benötigen, bitten Sie den Kunden, Sie per E-Mail zu kontaktieren, und diskutieren Sie stattdessen in Rezensionen. Wenn Sie das Problem beheben, aktualisieren Sie Ihre Antwort mit der Lösung. Sie können Ihre Antwort bearbeiten, genau wie Kunden ihre Rezensionen bearbeiten können.
- Wenn Sie unangemessene Rezensionen wie Spam, missbräuchliche oder anstößige Inhalte für jede Erweiterung feststellen, kennzeichnen Sie sie für unsere Überprüfung.
Anforderung, eine Überprüfung zu stornieren
Als Herausgeber können Sie eine Überprüfung nichtig machen, wenn das gemeldete Problem aufgrund des Marketplace oder der zugrunde liegenden Plattform liegt. Wenn das Problem gültig ist, ungültige Marketplace-Administratoren die Bewertung. Sie können über Bewertungen und den Abschnitt "Review" auf Ihrer Erweiterungshubseite ansprechen .
Aufheben der Veröffentlichung einer Erweiterung
Sie können die Veröffentlichung kostenloser Erweiterungen aufheben, wenn Sie sie nicht mehr im Marketplace anbieten möchten.
Die folgenden Szenarien decken ab, wenn Sie Ihre Erweiterung möglicherweise aus dem Marketplace entfernen möchten:
- Sie haben eine weitere Erweiterung entwickelt und möchten die aktuelle Erweiterung nicht mehr anbieten.
- Ihre Erweiterung hat ein Problem, sodass Sie Ihre Erweiterung aus dem Marketplace entfernen möchten, bis Sie das Problem beheben.
- Sie haben Ihre Erweiterung versehentlich als öffentlich veröffentlicht.
Bestimmte Kriterien müssen erfüllt sein, damit eine Erweiterung aufgehoben oder entfernt werden kann:
Aktion | Anforderungen |
---|---|
Veröffentlichung aufheben | Nur kostenlose Erweiterungen werden möglicherweise nicht veröffentlicht. |
Remove (Entfernen) | Die Erweiterung muss null (0) installiert sein, damit sie entfernt werden kann. |
Wichtig
Wenn Sie Ihre Verlängerung aufgrund von rechtlichen oder Sicherheitsproblemen entfernen müssen, wenden Sie sich an den Kundensupport am Entwicklercommunity. Wir überprüfen die Anforderung und löschen die Erweiterung manuell.
Wählen Sie die Erweiterung auf Ihrer Herausgeberseite aus, und wählen Sie im Menü die Option "Veröffentlichung aufheben" aus.
Ihre Erweiterung wird sofort vom Marketplace veröffentlicht, und neue Benutzer können sie nicht installieren. Bewertungen und Rezensionen für Ihre Erweiterung bleiben intakt.
Wenn Sie Ihre Erweiterung erneut im Marketplace anbieten möchten, wählen Sie im Menü "Veröffentlichen" aus.
Sie können ihre Erweiterung auch vollständig aus dem Marketplace entfernen, wenn Ihre Erweiterung null (0) installiert ist. Wählen Sie dazu im Menü "Entfernen" aus. Diese Aktion kann nicht rückgängig gemacht werden.