chore: rework plugin readmes, json changelogs and standalone repo setup

2026-10-29 06:35:24 +00:00 · 2026-10-04 21:25:16 -05:00
1 parent a8f383d2b3
commit 29a946d02e
@@ -0,0 +1,21 @@
+{
+  "extends": ["@commitlint/config-conventional"],
+  "rules": {
+    "type-enum": [
+      2,
+      "always",
+      [
+        "feat",
+        "fix",
+        "docs",
+        "style",
+        "refactor",
+        "perf",
+        "test",
+        "chore",
+        "revert"
+      ]
+    ],
+    "subject-case": [0]
+  }
+}
@@ -0,0 +1 @@
+custom: https://donate.termix.site/
@@ -0,0 +1,34 @@
+# Overview
+
+_Short summary of what this PR does_
+
+- [ ] Added: ...
+- [ ] Updated: ...
+- [ ] Removed: ...
+- [ ] Fixed: ...
+
+# Changes Made
+
+_Detailed explanation of changes (if needed)_
+
+- ...
+
+# Related Issues
+
+_Link any issues this PR addresses_
+
+- Closes #ISSUE_NUMBER
+- Related to #ISSUE_NUMBER
+
+# Screenshots / Demos
+
+_(Optional: add before/after screenshots, GIFs, or console output)_
+
+# Checklist
+
+- [ ] Code follows project style guidelines
+- [ ] Supports mobile and desktop UI/app (if applicable)
+- [ ] Added the change to `CHANGELOG.json`
+- [ ] `npm run test`, `npm run typecheck` and `npm run validate` pass
+- [ ] I have read `CONTRIBUTING.md`
+- [ ] This is not a translation request. See [docs](https://docs.termix.site/translations)
@@ -0,0 +1,9 @@
+node_modules
+dist
+coverage
+*.log
+.env
+*.tmxplug
+*.tmxplug.sig
+termix-plugin-signing.key
+.termix-tables-*
@@ -0,0 +1 @@
+npx --no -- commitlint --edit "$1"
@@ -0,0 +1 @@
+npx lint-staged
@@ -0,0 +1,4 @@
+dist
+coverage
+node_modules
+package-lock.json
@@ -0,0 +1,9 @@
+{
+  "semi": true,
+  "singleQuote": false,
+  "tabWidth": 2,
+  "trailingComma": "all",
+  "printWidth": 80,
+  "arrowParens": "always",
+  "endOfLine": "lf"
+}
@@ -0,0 +1,26 @@
+{
+  "$schema": "https://raw.githubusercontent.com/Termix-SSH/Termix/main/packages/plugin-sdk/schema/changelog.schema.json",
+  "releases": [
+    {
+      "version": "1.0.0",
+      "changes": [
+        {
+          "type": "added",
+          "text": "Adds the Step CA auth type to hosts"
+        },
+        {
+          "type": "added",
+          "text": "Sign in with your identity provider in the browser"
+        },
+        {
+          "type": "added",
+          "text": "Certificates are kept until they expire"
+        },
+        {
+          "type": "added",
+          "text": "No `step` binary needed"
+        }
+      ]
+    }
+  ]
+}
@@ -1,7 +0,0 @@
-# Changelog
-
-## 1.0.0
-
-First release, bundled with Termix 2.9.0.
-
-Adds the Step CA login type. Termix signs you in through a smallstep step-ca OIDC provisioner and gets a short-lived SSH certificate from the CA.
@@ -0,0 +1,20 @@
+# Contributing to Step CA
+
+## Development
+
+```bash
+npm run build      # build into dist/
+npm run test       # run this plugin's tests
+npm run typecheck  # type-check this plugin
+npm run validate   # check manifest.json
+npm run format     # format the code with Prettier
+```
+
+## Settings
+
+### Admin
+
+- **CA URL, Root fingerprint and OIDC provisioner name:** leave all three empty to turn Step CA off
+- **Allowed private Step CA hosts:** the CA and, if it is internal, the identity provider. Private hosts not on this list are refused
+- **Redirect URI:** register `<base URL>/plugin-api/step-ca/callback` with your identity provider
+- **Use the old redirect URI:** keep sending the 2.8 URI `<base URL>/host/step-ca-callback`. Upgraded installs keep this on until you turn it off
@@ -1,31 +1,38 @@
-# Step CA
+<div align="center">

-Connect to hosts with short-lived SSH certificates from a smallstep step-ca server, after signing in through its OIDC provisioner.
+<img src="https://raw.githubusercontent.com/Termix-SSH/Termix/main/public/icon.svg" width="120" height="120" alt="Termix Logo" />
+
+<h1>Step CA</h1>
+
+<p>Short-lived SSH certificates from your own step-ca server</p>
+
+</div>
+
+<br />
+
+## Overview
+
+Step CA lets you connect to hosts with short-lived SSH certificates from a [smallstep step-ca](https://smallstep.com/docs/step-ca/) server, after signing in through its OIDC provisioner.
+
+<br />

 ## Features

- Adds the Step CA login type to the host editor.
- Signs you in through the identity provider behind a [smallstep step-ca](https://smallstep.com/docs/step-ca/) OIDC provisioner.
- Has the CA sign a fresh key and keeps the certificate until it expires.
- Talks to the CA's HTTPS API directly, so the `step` binary is never needed.
+- Adds the Step CA auth type to hosts
+- Sign in with your identity provider in the browser
+- Certificates are kept until they expire
+- No `step` binary needed

-## Setup
+<br />

-When `REDIS_URL` is set and you run more than one Termix instance, a callback that reaches the wrong instance is handed to the one that started the sign-in. `TERMIX_STEP_CA_REDIS_PREFIX` changes the key prefix, which defaults to `termix:step-ca`.
+## Support

-## Settings
+To report a bug or request a feature, open a [support ticket](https://github.com/Termix-SSH/Support/issues/new/choose). You need to be logged in to GitHub. Please be as detailed as possible, preferably in English.

-### Admin
+For discussions and questions, join the [Discord](https://discord.gg/jVQGdvHDrf) server.

- CA URL, Root fingerprint and OIDC provisioner name: leave all three empty to turn Step CA off.
- Allowed private Step CA hosts: the CA and, if it is internal, the identity provider. Private hosts not on this list are refused.
- Redirect URI: register `<base URL>/plugin-api/step-ca/callback` with your identity provider.
- Use the old redirect URI: keep sending the 2.8 URI `<base URL>/host/step-ca-callback`. Upgraded installs keep this on until you turn it off.
+<br />

-## Development
+## License

-```bash
-npm run build      # build into dist/
-npm run test       # run this plugin's tests
-npm run typecheck  # type-check this plugin
-```
+Distributed under the Apache License Version 2.0. See [LICENSE](https://github.com/Termix-SSH/Termix/blob/main/LICENSE) for more information.
@@ -2,16 +2,16 @@
  "id": "step-ca",
  "name": "Step CA",
  "version": "1.0.0",
-  "description": "Connect to hosts with short-lived SSH certificates from a smallstep step-ca server, after signing in through its OIDC provisioner.",
+  "description": "Connect to hosts with short-lived SSH certificates from a smallstep step-ca server.",
  "author": {
    "name": "Termix"
  },
-  "license": "MIT",
+  "license": "Apache-2.0",
  "repository": "https://github.com/Termix-SSH/Termix",
  "category": "Access & Security",
  "icon": "ShieldCheck",
  "engine": {
-    "termix": ">=2.9.0",
+    "termix": ">=26.10.0",
    "api": "1"
  },
  "capabilities": [
@@ -7,13 +7,18 @@
    "build": "termix-plugin build",
    "test": "termix-plugin test",
    "typecheck": "tsc -p .",
-    "validate": "termix-plugin validate"
+    "validate": "termix-plugin validate",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
+    "prepare": "husky || true"
  },
  "dependencies": {
    "lucide-react": "^1.33.0",
    "redis": "^6.2.1"
  },
  "devDependencies": {
+    "@commitlint/cli": "^21.2.2",
+    "@commitlint/config-conventional": "^21.2.0",
    "@termix/plugin-sdk": "^1.0.0",
    "@testing-library/dom": "^10.4.2",
    "@testing-library/react": "^16.3.3",
@@ -21,7 +26,10 @@
    "@types/react": "^19.2.18",
    "@types/react-dom": "^19.2.4",
    "better-sqlite3": "^13.0.3",
+    "husky": "^9.1.7",
    "jsdom": "^30.0.1",
+    "lint-staged": "^17.2.0",
+    "prettier": "3.9.9",
    "vitest": "^4.1.11"
  },
  "peerDependencies": {
@@ -30,5 +38,10 @@
    "express": "^5.2.1",
    "react": "^19.2.8",
    "sonner": "^2.0.8"
+  },
+  "lint-staged": {
+    "*.{ts,tsx,js,jsx,mjs,cjs,json,css,md}": [
+      "prettier --write"
+    ]
  }
 }