chore: simplify plugin readmes, changelogs and manifest descriptions

This commit is contained in:
LukeGus committed 2026-09-27 00:24:48 -05:00
1 parent 7423e33184
commit 8043d6dbdd
96 files changed
+1147 -722

No files matched your search

+3 -1
View File
@@ -2,4 +2,6 @@
## 1.0.0
Bundled with Termix 2.9.0.
First release, bundled with Termix 2.9.0.
Runs actions on your hosts on a schedule or when something happens, like a host going down, a metric crossing a limit, a container event or an incoming webhook. Each automation is a list of steps, such as running a command, sending an alert or calling a URL.
+31 -14
View File
@@ -1,22 +1,39 @@
# Automations
Trigger-and-action automation engine: schedules, metric/status/docker-event triggers, and multi-step actions across managed hosts.
Run actions on your hosts on a schedule or when something happens, like a host going down or a metric crossing a limit.
Bundled with Termix and enabled by default.
## Features
## Layout
- Triggers: a schedule, a host going up or down, a metric crossing a limit, a health check change, a container event, a Termix event or an incoming webhook.
- Steps: send an alert, call a URL, run a snippet or command, control a container or tunnel, wake a host, wait, set a variable, branch with if / otherwise, run another automation or stop.
- Run an automation on the host that triggered it or on any host or fleet you pick.
- See the output and errors of each step for every run.
manifest.json id, capabilities and what this plugin contributes
src/backend/ activate(ctx) / deactivate(), plus the routes
src/frontend/ the UI it registers
locales/en.json its strings (English only; the rest are translated)
tests/backend/ vitest, node
tests/frontend/ vitest, jsdom
## Permissions
## Commands
- `automations.view`: See automations and their runs. Admins and users have it by default.
- `automations.create`: Create automations. Admins and users have it by default.
- `automations.edit`: Change automations. Admins and users have it by default.
- `automations.delete`: Delete automations. Admins and users have it by default.
- `automations.run`: Run automations by hand. Admins and users have it by default.
npm run build bundle into dist/
npm run test run this plugin's tests
npm run typecheck
## Services
See packages/plugin-sdk/ARCHITECTURE.md for the contract this follows.
Provides to other plugins:
- `automations.access`: list and run automations.
Uses from other plugins:
- `snippets.access` for the run snippet step. Required.
- `fleets.access`, `tunnels.access`, `docker.containers`, `docker.events`, `host-metrics.viewers` and `wake-on-lan.send` for their steps and triggers. Each one is optional.
## Development
```bash
npm run build # build into dist/
npm run test # run this plugin's tests
npm run typecheck # type-check this plugin
```
See `packages/plugin-sdk/ARCHITECTURE.md` for the plugin contract.
+1 -1
View File
@@ -2,7 +2,7 @@
"id": "automations",
"name": "Automations",
"version": "1.0.0",
"description": "Trigger-and-action automation engine: schedules, metric/status/docker-event triggers, and multi-step actions across managed hosts.",
"description": "Run actions on your hosts on a schedule or when something happens, like a host going down or a metric crossing a limit.",
"author": {
"name": "Termix"
},