Anleitung zum Veröffentlichen von Plugins

Diese Anleitung richtet sich an Plugin-Autor:innen, die ein Plugin-Release veröffentlichen und über die SemRels Plugin Registry auffindbar machen möchten.

Die Kurzfassung:

1. Erstelle eine versionierte Release in deinem Plugin-Repository,
2. lade plattformspezifische Binärdateien hoch,
3. erzeuge SHA-256-Prüfsummen,
4. reiche die Release-Metadaten im Registry-Repository ein.

Verwende Standard-SemVer-Tags und GitHub-Release-Namen:

• Stable release: v1.2.3
• Prerelease: v1.2.3-rc.1
• Patch release: v1.2.4

Halte Git-Tag, GitHub-Release-Titel und die Versionsangabe in den Registry-Metadaten exakt synchron. So vermeidest du defekte Links und machst klar, welches Asset zu welcher Plugin-Version gehört.

Der Registry-Client lädt das in downloadUrl referenzierte Asset direkt herunter. Deshalb muss das Release-Asset die ausführbare Binärdatei selbst sein – kein .zip- oder .tar.gz-Archiv.

Technisch kann der Dateiname zwar jede direkte Binärdatei sein, aber die folgende Konvention macht Releases leichter prüfbar und automatisierbar:

Ersetze provider-github durch den Registry-Namen deines Plugins.

Erzeuge für jedes hochgeladene Asset SHA-256-Prüfsummen.

sha256sum provider-github_linux_amd64
sha256sum provider-github_darwin_arm64

Get-FileHash .\provider-github_windows_amd64.exe -Algorithm SHA256

Die Werte kommen in den Registry-Metadaten unter Plattformschlüsseln wie linux_amd64, darwin_arm64 oder windows_amd64 hinein.

1. Bereite das Plugin-Release vor

   • aktualisiere deinen Changelog oder deine Release Notes
   • baue Binärdateien für jede unterstützte Plattform
   • prüfe, dass das Plugin Logs nach stderr schreibt, nicht nach stdout

2. Erstelle ein Versions-Tag

   git tag v1.2.3
   git push origin v1.2.3

3. Lade Release-Assets hoch

   Hänge direkte ausführbare Binärdateien an die GitHub-Release an, zum Beispiel:

   provider-github_linux_amd64
   provider-github_darwin_arm64
   provider-github_windows_amd64.exe

4. Erzeuge SHA-256-Prüfsummen

   Notiere eine Prüfsumme pro OS-/Architektur-Paar.

5. Bereite Registry-Metadaten vor

   Option A — Community submission (empfohlen für externe Plugins): Reiche sie über die Registry-Weboberfläche unter registry.semrel.io/submit ein. Dein Plugin wird dann zur Prüfung durch Maintainer in die Warteschlange gestellt.

   Option B — Pull request against the registry: Öffne einen Pull Request gegen SemRels/semrel-registry mit den Metadaten für das neue Plugin oder die neue Version.

   {
     "name": "provider-github",
     "description": "GitHub provider plugin for semrel",
     "author": "SemRels",
     "license": "Apache-2.0",
     "category": "provider",
     "repository": "https://github.com/SemRels/semrel-plugins",
     "versions": [
       {
         "version": "1.2.3",
         "releaseDate": "2026-05-24T12:00:00Z",
         "downloadUrl": "https://github.com/SemRels/semrel-plugins/releases/download/v1.2.3/provider-github_linux_amd64",
         "checksums": {
           "linux_amd64": "<sha256>",
           "darwin_arm64": "<sha256>",
           "windows_amd64": "<sha256>"
         }
       }
     ]
   }

6. Warte auf Registry-Validierung und Merge

   Nachdem der PR gemergt wurde, prüfe, ob dein Plugin in plugins.json vorhanden und über den öffentlichen Registry-Endpunkt erreichbar ist.

• Plugin Registry — alle veröffentlichten Plugins durchsuchen
• Submit a plugin — Formular für Community-Einreichungen
• Registry API — maschinenlesbares JSON
• semrel-registry release guide
• Plugin submission overview
• Plugin Registry overview