Einen Plug-in-Marktplatz auf GitHub erstellen und teilen

Veröffentlichen Sie einen GitHubgehosteten Marketplace, damit Benutzer Plug-Ins in unterstützten Copilot Clients entdecken und installieren können.

In diesem Artikel

Marketplaces verteilen Plug-Ins für unterstützte Copilot Clients. Sie können in einem GitHub Repository, einem anderen Git-Host oder einem lokalen Verzeichnis gehostet werden. In diesem Artikel wird beschrieben, wie Sie einen Marketplace in einem GitHub Repository veröffentlichen. Eine Übersicht findest du unter Plug-Ins für GitHub Copilot.

Bevor Sie anfangen

  • Erstellen Sie ein oder mehrere Plug-Ins, die in den Clients funktionieren, in denen die Benutzer sie verwenden werden. Anleitungen zu Format und Inhaltserstellung GitHub Copilot CLI finden Sie unter Erstellen eines Plug-Ins für GitHub Copilot CLI.
  • Visual Studio Code Anleitungen zum Formatieren und Erstellen finden Sie in der Erstellungsreferenz für Agent Plugins.
  • Wählen Sie einen stabilen, kebab-case Marketplace-Namen aus, z. B. engineering-tools. Plugin-IDs enthalten diesen Namen, sodass eine Änderung dieses Namens auch den Bezeichner ändert, den Benutzer in Einstellungen und Befehlen verwenden.

Marketplace-Repository erstellen

Erstellen Sie ein Repository für den Marketplace. Sie können mit der Plug-In Marketplace-Startvorlage beginnen und den Anweisungen in der README folgen, um die Entwicklungsabhängigkeiten zu installieren und den Marketplace-Namen festzulegen, oder die Dateien selbst zu erstellen. Wenn Sie die Vorlage verwenden, entfernen Sie alle Beispiel-Plug-Ins, die Sie nicht teilen möchten.

  1. Fügen Sie eine marketplace.json Katalogdatei in .github/plugin/ hinzu.
  2. Fügen Sie jedes Plug-in-Verzeichnis unter dem im Feld source angegebenen Pfad hinzu. Wenn die Quelle beispielsweise lautet ./plugins/frontend-design, fügen Sie das frontend-design Verzeichnis unter plugins/ im Repository hinzu.
  3. Fügen Sie einen stabilen Kebab-Case-Wert für das name des Marketplace hinzu.
  4. Aktualisieren .github/CODEOWNERS, Beitragsanweisungen und Issue- und Pull-Request-Vorlagen, damit sie dazu passen, wie Sie den Marketplace verwalten möchten.
  5. Wenn Sie die Startvorlage verwenden, folgen Sie der zugehörigen README, um npm run verify auszuführen. In der Vorlage wird dieser Befehl als Überprüfung des Katalogs, der Manifeste, tests und der Auswertungsabdeckung beschrieben. Lassen Sie den .github/workflows/validate.yml Workflow aktiviert, um modellfreie Prüfungen für Pull Requests und Pushs auszuführen. Überprüfen Sie die aktuelle README und den aktuellen Workflow, da sich Vorlagenüberprüfungen ändern können.

Die marketplace.json Datei ist der erforderliche Marketplace-Katalog. Es stellt Marketplace-Metadaten bereit und listet Plug-ins auf. Das Feld der obersten Ebene plugins ist ein Array von Plug-In-Einträgen mit Metadaten wie Name, Beschreibung, Version und Quelle jedes Plug-Ins. Ein Beispielkatalog, siehe marketplace.json in github/awesome-copilot.

Unterstützte Katalogfelder und andere Marketplace-Dateispeicherorte finden Sie unter Plugin- und Marketplace-Referenz.

Marktplatz überprüfen und verwalten

Überprüfen Sie Plug-in-Änderungen im Rahmen der gemeinsam genutzten Agenteninfrastruktur. Testen Sie das Plug-In-Verhalten vor dem Veröffentlichen von Updates und halten Sie Auswertungen im Kontext, den sie bewerten sollen. Überprüfen Sie Katalogeinträge und Plug-In-Quellen, wenn Sie das Repository aktualisieren.

Marketplace teilen

Personen, die den Marketplace hinzufügen oder dessen Plugins erhalten, benötigen Lesezugriff auf das Repository und müssen in ihrem Client bei GitHub angemeldet sein. Für einen privaten Marketplace hosten Sie ihn in Ihrer Organisation und gewähren Sie seinen Benutzern Zugriff. Die Organisationsmitgliedschaft allein garantiert keinen Zugriff auf ein privates Repository.

Teilen Sie nach der Veröffentlichung des Repositorys ihre URL mit Personen, die es einem Client hinzufügen müssen. Sie können Plug-Ins auch über freigegebene Einstellungen verfügbar machen:

Weiterführende Lektüre