SIGNALS Docs
Exit Reader View
100%
Theme

Plugin packaging

Archive layout, registry submission, review tiers and artifact verification.

Build an archive

The ZIP must contain composer.json and signals.yaml at its package root, either directly or inside one enclosing directory. Composer's name must match the manifest package, and extra.signals.plugin must name the entry class. Include the class files covered by your PSR-4 mapping and any package migrations.

review-test/
  composer.json
  signals.yaml
  src/
    ReviewPlugin.php
  database/
    migrations/

PluginPackageArchive rejects unsafe paths, duplicate normalised entries and symbolic links. Defaults in config/plugins.php are 10,240 KB compressed upload size, 51,200 KB uncompressed size and 10,000 archive entries. Operators can configure these limits. On self-hosted installations, upload the archive through the Plugin Manager, inspect the proposed capabilities and approve the concrete package operation.

Registry submission and tiers

Follow the registry README for an overview of tiers and review. Put the entry at plugins/<vendor>/<package>.json; for example, acme/review-test belongs at plugins/acme/review-test.json. Validate it against the registry entry schema included in the source repository. The entry is a pointer with curation metadata; plugin code remains in its own repository.

The README describes verified packages as reviewed by Signals and eligible for Signals Cloud. Community packages are listed without review and are for self-hosted installations. A listing does not change the package licence or imply endorsement. A declaration of tier in a file does not replace the registry's review process. Cloud additionally requires the latest version to equal the reviewed version, and rejects manual archive uploads.

Integrity and signing

PluginArtifactIntegrity hashes package artifacts and manifests with SHA-256 and verifies expected digests; directory hashing refuses symbolic links. PluginRegistrySignatureVerifier verifies detached Ed25519 signatures for registry releases and indexes against configured trusted keys. Missing, revoked or unknown key IDs, unsupported algorithms, malformed signatures and failed verification are rejected.

Release signatures bind the package, version, host constraint, release ref, archive URL and artifact/manifest digests. Index signing uses recursively canonicalised JSON without the signature field. A hash detects changed bytes; trusted-key signature verification establishes whether signed registry metadata is accepted by the host. Follow the registry's signing and review process rather than adding an arbitrary signature file to the ZIP.