@mercury-fw/kit 0.38.0 → 0.39.0

package/CHANGELOG.md

@@ -1,5 +1,32 @@
 # @mercury-fw/kit
 
+## 0.39.0
+
+### Minor Changes
+
+- 881835c: A CLI's login is set up inside the app's container, no longer carried in the env file.
+
+  - A plugin declares in `mercury.cliCredentials` the commands that set its CLI's login up (`setup`, required), check it (`check`) and log an identity out (`logout`), each a binary followed by its arguments.
+  - `mfw credentials setup <plugin>` runs the declared setup in a one-off container on your terminal, so the CLI writes its login straight onto the credentials volume; `mfw credentials check <plugin>` runs the declared check.
+  - `mfw credentials reset <plugin> [--user <key>]` runs the declared logout, of the identity Mercury runs as or of one person, instead of deleting the CLI's folder.
+  - `mfw credentials set` is removed, and the core no longer unpacks `*_CONFIG_TAR_B64` variables at startup: it reports a declared login that isn't set up yet, and still links a login kept outside `~/.config` to the volume.
+  - A command the model writes with `--user` is refused: which person a CLI acts as is never the model's to pick.
+  - `cliUserId` (`@mercury-fw/utils`) maps a user key to the id a CLI knows a person by.
+  - plugin-jira and plugin-bitbucket pin their CLIs at 2.1.0, which keep the service identity and each person apart and refuse the old login folder. After updating, remove the plugin's `*_CONFIG_TAR_B64` line from the env file and run `mfw credentials setup` once; on Jira, Mercury now runs as an Atlassian Service Account.
+  - plugin-atlassian-admin keeps its CLI at 0.1.2, whose `init` doesn't prompt for the organization key: until it does, write the key from `mfw shell` with `atlassian-admin init --api-key <KEY> --org-id <ORG_ID>` (the plugin's README says so).
+
+### Patch Changes
+
+- @mercury-fw/plugin-types@0.39.0
+- @mercury-fw/channel-types@0.39.0
+
+## 0.38.1
+
+### Patch Changes
+
+- @mercury-fw/plugin-types@0.38.1
+- @mercury-fw/channel-types@0.38.1
+
 ## 0.38.0
 
 ### Patch Changes

package/README.md

@@ -7,14 +7,19 @@ A plugin whose CLI keeps its login in a folder under the home, reading it from t
 ```json
 {
   "mercury": {
-    "cliCredentials": { "folder": "my-cli" }
+    "cliCredentials": {
+      "folder": "my-cli",
+      "setup": ["my-cli", "init"],
+      "check": ["my-cli", "doctor"],
+      "logout": ["my-cli", "auth", "logout"]
+    }
   }
 }
 ```
 
-or anywhere else under the home, with `{ "path": ".my-cli" }` instead (relative to the home, inside it).
+or anywhere else under the home, with `{ "path": ".my-cli" }` instead of `folder` (relative to the home, inside it). Each command is a binary on the container's PATH followed by its arguments: `setup` sets up the identity the agent runs as and is required, `check` and `logout` (of that identity, or of one person with `--user <id>`) are optional.
 
-An app then carries the login into its container with `mfw credentials set <plugin>`, and unpacks it at startup onto a volume that keeps what the CLI writes back (a folder outside `~/.config` gets a link from its usual place to the volume). A CLI that authenticates any other way isn't covered by this, and neither is one that deletes its own folder and makes it again.
+An app then runs `mfw credentials setup <plugin>`, which runs `setup` in a one-off container on the user's terminal, so the CLI asks for what it needs and writes its login straight onto a volume that keeps what the CLI writes back (a folder outside `~/.config` gets a link from its usual place to the volume). A CLI that authenticates any other way isn't covered by this, and neither is one that deletes its own folder and makes it again.
 
 A proper workflow for writing plugins, with an SDK on top of these contracts, is planned ([#27](https://github.com/lucabro81/mercury-fw/issues/27)).
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mercury-fw/kit",
-  "version": "0.38.0",
+  "version": "0.39.0",
   "type": "module",
   "license": "MIT",
   "repository": {
@@ -27,8 +27,8 @@
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@mercury-fw/channel-types": "0.38.0",
-    "@mercury-fw/plugin-types": "0.38.0"
+    "@mercury-fw/channel-types": "0.39.0",
+    "@mercury-fw/plugin-types": "0.39.0"
   },
   "devDependencies": {
     "@mercury-fw/typescript-config": "*",