Releasing
A release is a .tmxplug file: a gzipped tar of your manifest, dist/, locales, migrations, README, changelog and icon. It is built the same on any machine, so the same commit always gives the same file and the same hash.
Versions
Plugins use semver. The version in manifest.json, package.json and the newest CHANGELOG.md section must match. termix-plugin validate checks it.
Betas are X.Y.Z-beta.N. Termix only offers them to people who put your plugin on the beta channel.
The changelog
CHANGELOG.md holds every release, newest first:
# Changelog
## 1.1.0
### Added
- A wave button in the terminal toolbar
### Fixed
- Notes keep their order after a restart
Sections are ### Added, ### Changed, ### Fixed, ### Removed, ### Deprecated and ### Security. No ## Unreleased: write notes under the version they ship in. Termix shows these notes on your plugin's page and before an update.
Build and pack by hand
npm run build
npm run validate
npm run pack
This writes <id>-<version>.tmxplug. Install it on a server with developer mode on, from Plugins, Install from file.
Sign it
npx termix-plugin keygen
TERMIX_PLUGIN_SIGNING_KEY="$(cat termix-plugin-signing.key)" npx termix-plugin sign hello-1.1.0.tmxplug
keygen writes a private key and prints the public key. Keep the private key secret and out of git. sign writes hello-1.1.0.tmxplug.sig. termix-plugin verify checks one.
Termix trusts the official and community keys built into it, and the key of each custom registry an admin added. A signed file installed by hand is still treated as unverified. To have Termix check your signature, list your plugin in your own registry. You don't need to sign a plugin you submit to the community registry. The registry signs it after review.
The release workflow
The template has a Release workflow that does all of this on GitHub. It calls a shared workflow in Termix-Registry, so fixes reach every plugin at once.
Work happens on a dev-X.Y.Z branch named after the version it will ship as. Run Release by hand from that branch:
| Choice | What it does |
|---|---|
| stable | Tests, builds and publishes X.Y.Z as a GitHub release, merges the branch into main and deletes it. |
| beta | Publishes X.Y.Z-beta.N. N counts up on its own. |
| dry-run | Builds and packs without publishing. |
Releases are immutable. A release is made as a draft, gets its files, then is published, and after that its tag and files can never change. A version that already has a release is refused, so a fix always ships as a new version. Turn on immutable releases in your repo settings (Settings, General, Releases).
The release notes come from your changelog. No secrets are needed: the workflow records GitHub build provenance for the file instead of signing it, and uploads it as .tmxplug.sigstore.json for Termix to check at download. To also sign it with your own key, set TERMIX_PLUGIN_SIGNING_KEY as a repo secret. If a dev branch changes files in .github/workflows, add a TERMIX_PAT secret (a token with repo and workflow scopes) so the release can push it to main.
CI also lints your workflows with zizmor and fails on high severity findings, like an action not pinned to a full commit SHA or an ${{ }} value inside a run: line (pass it through env: instead). Termix-SSH workflows may stay on @main. Add .github/zizmor.yml to change the rules.
After you release
Official plugins are picked up by the registry within the hour, and their docs on this site rebuild from the release. For your own plugin, the run's summary shows what to put in a community registry submission.