@fibteq/altair-runner 0.2.2 → 0.3.1

package/README.md

@@ -48,6 +48,21 @@ from npm and restarts the background runner on it (`service install` again also
 `service uninstall` removes it. On Linux it starts when you log in; to start at boot without logging in, run
 `loginctl enable-linger`.
 
+### Threads working at the same time
+
+When a shared folder is a git repository, each thread works in its own
+[git worktree](https://git-scm.com/docs/git-worktree) on its own branch, `altair/thr-…`, made from the repository's
+current commit on the thread's first task. Two threads can then work in the same project at once without changing
+each other's files or switching each other's branch, and your own checkout is left alone. Each task's result says
+which branch and folder the work is in; merge or open a PR from that branch as usual.
+
+Worktrees live in `~/.altair-runner/worktrees`. They start without your uncommitted changes and without ignored files
+such as `node_modules` or `.env`, so a task may need to install dependencies first. A worktree that has not been used
+for a day, has no uncommitted changes and whose branch is merged into your checkout's branch is removed
+automatically, with its branch. `altair-runner worktrees` lists them, `worktrees prune` cleans up now,
+`worktrees remove <path or branch>` removes one, and `worktrees off` makes threads work in the folder itself again.
+Read-only tasks (`--access read`) always run in the folder itself.
+
 ### What the CLI may do
 
 `altair-runner start --access <level>` or `altair-runner service install --access <level>` (saved for next time):
@@ -92,13 +107,16 @@ node packages/altair-runner/dist/cli.js --help
 
 ## Releasing
 
-Needs an npm account that is a member of the `fibteq` npm organization.
-
 1. Bump `version` in `package.json` here and in `packages/altair-runner-alias/package.json`, and `RUNNER_VERSION`
    in `src/runner.ts` (a test checks they match). Bump `RUNNER_PROTOCOL_VERSION` in `@altair/protocol` only when the
    wire format changes; the server refuses runners on another protocol version and tells them to update.
-2. Publish the runner first, then the short name, with `pnpm` (it replaces `workspace:` versions and uses the
-   built files from `publishConfig`):
+2. Merge it. The [Release altair-runner](../../.github/workflows/release-runner.yml) workflow then tests, builds and
+   publishes both packages whose version is not on npm yet (it can also be run by hand from the Actions tab).
+   It uses npm trusted publishing: once, on npmjs.com, open each package's **Settings > Trusted publishing**, choose
+   GitHub Actions and enter `Fibteq-Inc`, `altair` and `release-runner.yml`.
+
+By hand instead (needs an npm account in the `fibteq` npm organization), runner first, then the short name, with
+`pnpm` (it replaces `workspace:` versions and uses the built files from `publishConfig`):
 
 ```sh
 npm login