Skip to main content

Community registry

The community registry lists plugins made by anyone. A person reviews every version before it is listed. It lives in Termix-Registry next to the official plugins, in community/.

Admins turn the community registry on in Plugins, Registries. Your plugin then shows in Browse with a Community badge.

Before you submit​

  • Your plugin is in a public GitHub repo with an open source license.
  • It was made from the plugin template, or uses the same .github/workflows/release.yml.
  • npm test, npm run typecheck, npm run validate and npm run build pass.
  • The id in manifest.json is not used by an official plugin or another submission.
  • manifest.json has a clear name, description and author, repository set to your repo, and a docs link or a README that explains how to use it. See docs.

Release it​

Run the Release workflow in your repo, as in releasing. No secrets are needed. For plugins outside the Termix team, the workflow:

  • publishes the .tmxplug as a GitHub release, without a signature
  • records GitHub build provenance for it, which proves the file was built by the release workflow from your repo
  • shows the version and sha256 to submit in the run's summary

Submit it​

Fork Termix-Registry and add community/plugins/<id>.json:

{
"$schema": "../../community-submission-schema.json",
"id": "my-plugin",
"repository": "https://github.com/you/termix-plugin-my-plugin",
"maintainers": ["you"],
"versions": [{ "version": "1.0.0", "sha256": "<from the run summary>" }]
}
FieldWhat it is
idThe id from your manifest. The file is named <id>.json.
repositoryThe GitHub repo the plugin is released from.
maintainersGitHub usernames allowed to send updates. You must be one of them.
versionsThe versions to list, newest first. Each one is the v<version> release.

Open a pull request. The Check submission job downloads your release and checks that:

  • the file has the sha256 you gave
  • the manifest in it has your id, version and repo
  • it has build provenance from the Termix release workflow
  • you are one of the maintainers

It writes a summary with links to your source at the tag, what changed since your last listed version, and your plugin's capabilities. Then a maintainer reviews the source and merges it. The registry signs the reviewed file with the community key and lists it in community/index.json a few minutes later.

Updates​

Every version is reviewed. Release the new version, then open a PR that adds it to the top of versions. Only a maintainer listed in the file can do that. Betas (X.Y.Z-beta.N) can be submitted the same way.

A listed version can't be swapped for another file. Releases are immutable, so a fix always ships as a new version that you submit again.

What reviewers check​

  • The source at the release tag does what the name and description say, and nothing else.
  • No obfuscated or minified source, and no code downloaded and run at runtime.
  • No network calls, tracking or telemetry the user did not ask for. Anything like that is off by default and explained in the docs.
  • Capabilities and permissions are the fewest the plugin needs. See capabilities.
  • package.json scripts and dependencies don't fetch or run anything unexpected during install or build.
  • Secrets and credentials are only used for what the plugin is for.
  • The name and icon don't pretend to be an official plugin.

A plugin can be removed if it breaks these rules later, stops working, or its repo goes away. To remove your own, open a PR that deletes its file.