Plugin Publishing Guide

Dieser Inhalt ist noch nicht in deiner Sprache verfügbar.

This guide is for plugin authors who want to publish a plugin release and make it discoverable through the SemRels Plugin Registry.

The short version is:

cut a versioned release in your plugin repository,
upload platform-specific binaries,
generate SHA-256 checksums,
submit the release metadata to the registry repository.

Release source

Publish from your own plugin repository. The registry indexes releases; it does not build your binaries for you.

Binary delivery

Upload direct executable assets for each supported platform. semrel downloads these files as-is.

Verification

Every registry entry should include SHA-256 checksums so semrel can validate the downloaded binary.

Release naming convention

Use standard SemVer tags and GitHub release names:

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

Keep the git tag, GitHub release title, and registry metadata version aligned exactly. This avoids broken links and makes it clear which asset belongs to which plugin version.

Binary asset naming

The registry client downloads the asset referenced in downloadUrl directly, so the release asset must be the executable binary itself — not a .zip or .tar.gz archive.

The filename can technically be any direct binary asset, but the following convention keeps releases easy to inspect and automate:

Platform	Recommended asset name
Linux amd64	`provider-github_linux_amd64`
Linux arm64	`provider-github_linux_arm64`
macOS arm64	`provider-github_darwin_arm64`
Windows amd64	`provider-github_windows_amd64.exe`

Replace provider-github with your plugin’s registry name.

Checksum generation

Generate SHA-256 checksums for every uploaded asset.

Linux / macOS

sha256sum provider-github_linux_amd64
sha256sum provider-github_darwin_arm64

PowerShell

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

The values go into the registry metadata under platform keys such as linux_amd64, darwin_arm64, or windows_amd64.

Step-by-step release process

Prepare the plugin release
- update your changelog or release notes
- build binaries for each supported platform
- confirm the plugin writes logs to stderr, not stdout
Create a version tag
Terminal window
```
git tag v1.2.3
git push origin v1.2.3
```
Upload release assets

Attach direct executable binaries to the GitHub release, for example:
```
provider-github_linux_amd64
provider-github_darwin_arm64
provider-github_windows_amd64.exe
```
Generate SHA-256 checksums

Record one checksum per OS/architecture pair.

Prepare registry metadata

Option A — Community submission (recommended for external plugins): Submit via the registry web UI at registry.semrel.io/submit. Your plugin will be queued for maintainer review.

Option B — Pull request against the registry: Open a pull request against SemRels/semrel-registry with the metadata for the new plugin or 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>"
      }
    }
  ]
}

Wait for registry validation and merge

After the PR merges, confirm that your plugin is present in plugins.json and reachable through the public registry endpoint.

Release guide and references

Plugin Registry — browse all published plugins
Submit a plugin — community submission form
Registry API — machine-readable JSON
semrel-registry release guide
Plugin submission overview
Plugin Registry overview

Troubleshooting

Problem	What to check
Release asset returns `404`	Confirm the GitHub release exists and the `downloadUrl` matches the exact asset name
Checksum mismatch	Recalculate the SHA-256 hash from the uploaded file, not from a local archive or a different build
Plugin not visible in the registry	Wait for the registry PR to merge, then verify `plugins.json` was regenerated
Wrong version selected	Make sure the git tag, release title, and metadata `version` field are identical
Windows download does not start	Ensure the Windows asset ends with `.exe` and points to the executable binary