@awebai/oats 0.52.0 → 0.54.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -1
- package/bin/oats.mjs +314 -92
- package/docs/capabilities.md +66 -4
- package/docs/configuration.md +66 -3
- package/docs/design/2026-09-23-workspace-module-contracts.md +3 -0
- package/docs/desktop-cli-api.md +696 -60
- package/docs/desktop-instance-start.md +25 -12
- package/docs/execution-targets.md +1 -0
- package/docs/implementation.md +184 -12
- package/docs/integrations.md +6 -3
- package/docs/knowledge.md +2 -2
- package/docs/macos-test-runs.md +246 -0
- package/docs/official-catalog.md +5 -5
- package/docs/packages.md +14 -14
- package/docs/release-lane.md +210 -6
- package/docs/release-notes/v0.53.0.md +1288 -0
- package/docs/release-notes/v0.54.0.md +142 -0
- package/docs/schedules.md +7 -1
- package/docs/souls-and-instances.md +239 -16
- package/docs/tui.md +453 -21
- package/docs/upgrading.md +310 -0
- package/docs/workspaces.md +123 -3
- package/lib/automations.mjs +22 -22
- package/lib/claim.mjs +93 -4
- package/lib/config-data.mjs +4 -1
- package/lib/core.mjs +569 -121
- package/lib/instance-events.mjs +19 -1
- package/lib/instance-git.mjs +39 -3
- package/lib/instance-inspect.mjs +5 -6
- package/lib/instance-lifecycle.mjs +145 -18
- package/lib/instance-resolution.mjs +59 -6
- package/lib/launch-preference.mjs +226 -15
- package/lib/local-edit.mjs +118 -0
- package/lib/packages.mjs +18 -5
- package/lib/pi-bridge.mjs +308 -0
- package/lib/refused-text.mjs +11 -0
- package/lib/remote.mjs +404 -60
- package/lib/resolve.mjs +2 -1
- package/lib/retained-after-retire.mjs +2 -2
- package/lib/retire-output.mjs +12 -1
- package/lib/schedule-host.mjs +6 -35
- package/lib/shell-word.mjs +13 -0
- package/lib/soul-launch-verbs.mjs +153 -0
- package/lib/stable-node.mjs +62 -0
- package/lib/teams-verbs.mjs +18 -46
- package/lib/workspace.mjs +75 -27
- package/package-catalog.json +4 -4
- package/package.json +2 -1
- package/packages/client/attach-exit.mjs +25 -0
- package/packages/client/cli-adapter.mjs +16 -3
- package/packages/client/cli-locator.mjs +2 -2
- package/packages/client/deployment-contract.mjs +4 -0
- package/packages/client/deployment-facts.mjs +71 -10
- package/packages/client/deployment-panel.mjs +49 -11
- package/packages/client/deployment-read-cli.mjs +7 -3
- package/packages/client/display-text.mjs +8 -2
- package/packages/client/instance-acts.mjs +46 -10
- package/packages/client/instance-events-contract.mjs +4 -2
- package/packages/client/instance-presentation.mjs +66 -2
- package/packages/client/instance-tree.mjs +23 -14
- package/packages/client/kernel-lines.mjs +31 -0
- package/packages/client/kernel-made.mjs +23 -0
- package/packages/client/launch-prompt-outcome.mjs +51 -16
- package/packages/client/lifecycle-contract.mjs +45 -4
- package/packages/client/liveness.mjs +14 -1
- package/packages/client/own-codes.mjs +31 -0
- package/packages/client/panel-views.mjs +18 -11
- package/packages/client/readiness-contract.mjs +3 -1
- package/packages/client/remote-address.mjs +34 -9
- package/packages/client/remote-identity-memory.mjs +94 -0
- package/packages/client/remote-roster.mjs +92 -6
- package/packages/client/session-attach.mjs +175 -0
- package/packages/client/spawn-apply-contract.mjs +16 -4
- package/packages/client/spawn-messages.mjs +26 -3
- package/packages/client/spawn-preview-cli.mjs +8 -2
- package/packages/client/spawn-preview-contract.mjs +5 -1
- package/packages/client/terminal-exec.mjs +21 -0
- package/packages/client/workspace-choices.mjs +95 -0
- package/packages/client/workspace-views.mjs +39 -3
- package/packages/record/README.md +21 -0
- package/packages/record/bin/setup.mjs +108 -15
- package/packages/tui/README.md +30 -12
- package/packages/tui/lib/actions.mjs +16 -1
- package/packages/tui/lib/client.mjs +32 -1
- package/packages/tui/lib/config.mjs +151 -0
- package/packages/tui/lib/main.mjs +117 -46
- package/packages/tui/lib/model.mjs +392 -0
- package/packages/tui/lib/read.mjs +473 -0
- package/packages/tui/lib/store.mjs +364 -0
- package/packages/tui/lib/term/keys.mjs +44 -0
- package/packages/tui/lib/term/screen.mjs +16 -4
- package/packages/tui/lib/term/text.mjs +60 -0
- package/packages/tui/lib/term/tty.mjs +13 -3
- package/packages/tui/lib/views/detail.mjs +46 -0
- package/packages/tui/lib/views/frame.mjs +230 -36
- package/packages/tui/lib/views/help.mjs +125 -13
- package/packages/tui/lib/views/instances.mjs +137 -0
- package/packages/tui/lib/views/scroll.mjs +19 -0
- package/packages/tui/lib/views/switcher.mjs +97 -0
- package/skills/oats-getting-started/SKILL.md +8 -2
|
@@ -0,0 +1,246 @@
|
|
|
1
|
+
# macOS test runs
|
|
2
|
+
|
|
3
|
+
Pull-request CI runs the tests on Linux only. Some tests rest on what only
|
|
4
|
+
macOS does: a file system that ignores case, `/var` and `/tmp` as links, long
|
|
5
|
+
temporary paths, the BSD tools. The workflow
|
|
6
|
+
[`macos-tests.yml`](../.github/workflows/macos-tests.yml) runs named test files
|
|
7
|
+
of a named ref on a macOS runner. A person starts it by hand; no push and no
|
|
8
|
+
pull request ever does. The link of its run goes on a pull request as that
|
|
9
|
+
pull request's macOS evidence.
|
|
10
|
+
|
|
11
|
+
It is not a second CI. It runs the files you name, each alone, and nothing
|
|
12
|
+
else: not `npm test`, not a shard.
|
|
13
|
+
|
|
14
|
+
## Starting a run
|
|
15
|
+
|
|
16
|
+
You need write access to the repository. From a checkout:
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
gh workflow run macos-tests.yml --ref main \
|
|
20
|
+
-f ref=my-branch \
|
|
21
|
+
-f files='test/tui-terminal.test.mjs test/fixture-isolation.test.mjs' \
|
|
22
|
+
-f tmux=true
|
|
23
|
+
gh run list --workflow=macos-tests.yml --limit 1
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
Or on the repository's Actions page: choose **macOS tests**, then **Run
|
|
27
|
+
workflow**. Leave the workflow's own branch at `main` (see
|
|
28
|
+
[What counts as evidence](#what-counts-as-evidence)).
|
|
29
|
+
|
|
30
|
+
| input | what it is |
|
|
31
|
+
|---|---|
|
|
32
|
+
| `ref` | The commit to test: a branch name, a tag name or a full commit id (40 characters) of this repository. |
|
|
33
|
+
| `files` | The test files, separated by spaces, commas or newlines. |
|
|
34
|
+
| `tmux` | `true` installs tmux first (`brew install tmux`). Off by default. Tests that need tmux skip without it. |
|
|
35
|
+
|
|
36
|
+
## What a run accepts
|
|
37
|
+
|
|
38
|
+
The script [`scripts/macos-tests.mjs`](../scripts/macos-tests.mjs) checks the
|
|
39
|
+
whole request before anything of the ref is checked out, installed or run. A
|
|
40
|
+
refusal names every entry it refuses and why, and the run fails having run
|
|
41
|
+
nothing.
|
|
42
|
+
|
|
43
|
+
**The ref** must be a commit of this repository: one reachable from a branch
|
|
44
|
+
or a tag of `origin`.
|
|
45
|
+
|
|
46
|
+
- A name is made of `A-Z a-z 0-9 . _ / -`, does not start with `-` and has no
|
|
47
|
+
`..`. A branch whose name has another character is given by its full commit
|
|
48
|
+
id. The text is taken as typed: a space before or after it is refused too.
|
|
49
|
+
- A shortened commit id is refused: give all 40 characters.
|
|
50
|
+
- **A pull request's number is not accepted.** A pull request from a fork has
|
|
51
|
+
a head that is not this repository's commit, and nothing is ever fetched by
|
|
52
|
+
what you typed. Name the branch, or give the commit id, of a pull request
|
|
53
|
+
whose branch is in this repository.
|
|
54
|
+
- A name that is both a branch and a tag is accepted when both are the same
|
|
55
|
+
commit. Otherwise give the commit id of the one you mean.
|
|
56
|
+
|
|
57
|
+
**Each file** must match `test/**/*.test.mjs` or
|
|
58
|
+
`packages/<name>/test/**/*.test.mjs`, with path segments made of
|
|
59
|
+
`A-Z a-z 0-9 . _ -`, none starting with a dot. It must be a regular file at
|
|
60
|
+
that commit, not a symbolic link. A file named twice runs once.
|
|
61
|
+
|
|
62
|
+
## What a run does and prints
|
|
63
|
+
|
|
64
|
+
The job checks out two trees. `runner/` is the workflow's own commit, and the
|
|
65
|
+
script runs from it. `tested/` is the ref. Two trees are for two things: a
|
|
66
|
+
ref older than the workflow can be tested, and an honest branch cannot change
|
|
67
|
+
the runner by accident. They are not a defence against a commit that sets out
|
|
68
|
+
to forge its result (see [What a run does not protect](#what-a-run-does-not-protect)).
|
|
69
|
+
|
|
70
|
+
After the validation the job installs as pull-request CI does (`npm ci` at
|
|
71
|
+
the root, then in `packages/desktop` without the Electron binary). Then it
|
|
72
|
+
runs each file alone, one after another, as a developer does: `node --test
|
|
73
|
+
<file>` from the root of the ref's tree.
|
|
74
|
+
|
|
75
|
+
The step **Validate the request and check out its commit** prints a header,
|
|
76
|
+
before any code of the ref has run:
|
|
77
|
+
|
|
78
|
+
- the commit under test (full id) and the ref that was asked for;
|
|
79
|
+
- the workflow's own ref and commit, as the script reads them (where a run
|
|
80
|
+
really ran from is GitHub's record of it, not this line: see
|
|
81
|
+
[What counts as evidence](#what-counts-as-evidence));
|
|
82
|
+
- the macOS version, the runner image and the architecture;
|
|
83
|
+
- the Node version;
|
|
84
|
+
- whether the file system is case-sensitive, measured there (a file is made,
|
|
85
|
+
then looked for by another case);
|
|
86
|
+
- whether `tmux` is on `PATH`, and its version;
|
|
87
|
+
- whether a socket is at tmux's default place for the server named `oats`.
|
|
88
|
+
|
|
89
|
+
Its last line says so: `Everything above this line was printed before any code
|
|
90
|
+
of the ref ran.` The step **Run each file alone** prints the header again
|
|
91
|
+
before the first file, read after the installs, and says that it is the second
|
|
92
|
+
reading.
|
|
93
|
+
|
|
94
|
+
For each file the log has its output, then its counts (tests, passed, failed,
|
|
95
|
+
skipped, cancelled, todo), its exit status and its duration. One table of all
|
|
96
|
+
files ends the log, and the job's summary page repeats it.
|
|
97
|
+
|
|
98
|
+
**What fails a run:**
|
|
99
|
+
|
|
100
|
+
- A file fails when its exit status is not 0. A file that ends with status 0
|
|
101
|
+
and prints no summary, or whose summary counts a failed test, fails too. The
|
|
102
|
+
files after a failing one still run.
|
|
103
|
+
- A file that has not ended after its time is killed with its whole process
|
|
104
|
+
group and reported as timed out. The run goes on.
|
|
105
|
+
- **A tmux server left on the default socket.** A fixture that fails to
|
|
106
|
+
isolate its tmux server starts one at tmux's default place
|
|
107
|
+
(`<dir>/tmux-<uid>/oats`, where `<dir>` is `TMUX_TMPDIR`, else `/tmp`). On a
|
|
108
|
+
clean runner nothing fails because of it. So the script looks at that place
|
|
109
|
+
before the first file and after each file. The file after which a socket
|
|
110
|
+
first exists is marked in the table, and the run fails. Nothing is killed or
|
|
111
|
+
removed. If a socket is there before the first file, the header says so and
|
|
112
|
+
the check is skipped for that run.
|
|
113
|
+
|
|
114
|
+
A file in which no test passed (every test skipped, for example without tmux)
|
|
115
|
+
is marked `no test passed`. It does not fail the run.
|
|
116
|
+
|
|
117
|
+
## What counts as evidence
|
|
118
|
+
|
|
119
|
+
**A run is evidence for a commit whose diff has been reviewed.** A run of a
|
|
120
|
+
commit that nobody has read proves nothing about it: from its first install
|
|
121
|
+
step on, the commit's own code runs on the runner and can change what the run
|
|
122
|
+
prints (see [What a run does not protect](#what-a-run-does-not-protect)).
|
|
123
|
+
|
|
124
|
+
The pull request gives **the run's link**. From it, a run is macOS evidence
|
|
125
|
+
when all of this holds. The first condition comes first because the others
|
|
126
|
+
rest on it.
|
|
127
|
+
|
|
128
|
+
1. **The workflow ran from `main`, by GitHub's own record of the run.** Not
|
|
129
|
+
by the log. A run started from another branch uses that branch's workflow
|
|
130
|
+
file and that branch's script, so every line of its log, the header
|
|
131
|
+
included, is text that branch wrote. Ask GitHub about the run instead:
|
|
132
|
+
|
|
133
|
+
```bash
|
|
134
|
+
gh run view <run id> --json event,headSha,workflowName
|
|
135
|
+
git fetch origin
|
|
136
|
+
git merge-base --is-ancestor <headSha> origin/main; echo $?
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
`event` must be `workflow_dispatch` and `workflowName` must be `macOS
|
|
140
|
+
tests`. The last command must print `0`: the workflow's commit is a commit
|
|
141
|
+
of `main`. Anything else is not a pass: `1` means the commit is not on
|
|
142
|
+
`main`, and an error means your clone does not have it. Check the commit,
|
|
143
|
+
not the run's branch name: a tag can carry a branch's name.
|
|
144
|
+
2. The `commit under test` in the validation step's header **equals the head
|
|
145
|
+
under review**. A run of an earlier head is evidence for that head only.
|
|
146
|
+
3. The run passed, and no file the pull request relies on is marked `no test
|
|
147
|
+
passed`. **A run of only skips is not evidence.**
|
|
148
|
+
|
|
149
|
+
The header also prints a `workflow ref` line. It is a convenience for
|
|
150
|
+
reading a run, and it is not proof of where the workflow ran from: the
|
|
151
|
+
workflow prints it.
|
|
152
|
+
|
|
153
|
+
With the first condition met, the log is the evidence. The job's summary page
|
|
154
|
+
is a convenience.
|
|
155
|
+
|
|
156
|
+
## Bounds
|
|
157
|
+
|
|
158
|
+
These are constants of the script, not inputs:
|
|
159
|
+
|
|
160
|
+
| bound | value |
|
|
161
|
+
|---|---|
|
|
162
|
+
| files in one run | at most 10 files |
|
|
163
|
+
| time for one file | 5 minutes, then its process group is killed |
|
|
164
|
+
| time for the job | 60 minutes |
|
|
165
|
+
| runner | `macos-14` (arm64), Node 22 |
|
|
166
|
+
|
|
167
|
+
The workflow's steps upload no artifact and save or restore no cache: the log
|
|
168
|
+
and the summary are all they leave. The token can read the repository's
|
|
169
|
+
contents and do nothing more, and the workflow names no secret. The code a run
|
|
170
|
+
executes can reach more than the workflow's own steps do: see
|
|
171
|
+
[What a run does not protect](#what-a-run-does-not-protect).
|
|
172
|
+
|
|
173
|
+
## What a run does not show
|
|
174
|
+
|
|
175
|
+
- **A clean machine, not yours.** The runner is a fresh image for each run.
|
|
176
|
+
It has no person's `PATH`, shell profile or login environment, and nothing
|
|
177
|
+
of an earlier run.
|
|
178
|
+
- **No real terminal.** No terminal emulator is attached to the tests.
|
|
179
|
+
- **One macOS version and one architecture**: the image's, printed in the
|
|
180
|
+
header.
|
|
181
|
+
- **A killed file's leftovers.** The script kills the process group of a file
|
|
182
|
+
that timed out. A tmux server has left that group by design, so a tmux
|
|
183
|
+
server of a killed file stays, and it is that test's to explain.
|
|
184
|
+
- **Nothing about `main`.** A run started from `main` is listed among the
|
|
185
|
+
runs of main's head commit (`gh run list --commit <sha>`) and among that
|
|
186
|
+
commit's check runs, as `Named test files on macOS`. Its result is about
|
|
187
|
+
the ref under test. It says nothing about `main`, a failed run included.
|
|
188
|
+
The commit's status rollup does not hold these runs. A macOS run can be the
|
|
189
|
+
newest run on `main`, so whoever checks `main` after a merge lists the runs
|
|
190
|
+
by workflow (`gh run list --workflow CI --branch main`) or reads the
|
|
191
|
+
commit's status rollup.
|
|
192
|
+
|
|
193
|
+
So a pull request that asks for a person's run on a Mac still gets one.
|
|
194
|
+
|
|
195
|
+
## What a run does not protect
|
|
196
|
+
|
|
197
|
+
After the validation, the ref's own code runs on the runner as the runner's
|
|
198
|
+
user: its install scripts, then its tests. Pull-request CI does the same for
|
|
199
|
+
every branch.
|
|
200
|
+
|
|
201
|
+
**Protected, in a run whose workflow commit is `main`'s: the validation and
|
|
202
|
+
the header.** They are printed from the workflow's own commit, before any
|
|
203
|
+
code of the ref has run. A commit under test cannot change which commit the
|
|
204
|
+
header names, or get a refused request past it. In a run started from another
|
|
205
|
+
branch nothing is protected: the workflow and the script are that branch's
|
|
206
|
+
(see [What counts as evidence](#what-counts-as-evidence)).
|
|
207
|
+
|
|
208
|
+
**Not protected: everything after the first install step**, the per-file
|
|
209
|
+
results and the table included. From there on, the ref's code can change
|
|
210
|
+
anything the runner's user can, and so what the later steps print. The result
|
|
211
|
+
is as honest as the commit.
|
|
212
|
+
|
|
213
|
+
**Where the check is.** A forgery has to be in the commit's own tree, its lock
|
|
214
|
+
file included. The evidence names that exact commit, and the reviewer of the
|
|
215
|
+
pull request reads its diff. Pull-request CI has the same property.
|
|
216
|
+
|
|
217
|
+
**The cache scope of the default branch.** A run started from the default
|
|
218
|
+
branch belongs to it, and executes another branch's code. Such code can reach
|
|
219
|
+
that run's Actions cache scope, which every branch reads. Only somebody with
|
|
220
|
+
write access can do it, by pushing the branch and starting the run. In the
|
|
221
|
+
maintainers' words: a run of this workflow can write the default branch's
|
|
222
|
+
cache scope; nothing reads it; a workflow that starts to restore a cache
|
|
223
|
+
reopens this. No workflow of this repository restores an Actions cache, and
|
|
224
|
+
the repository's tests keep it so.
|
|
225
|
+
|
|
226
|
+
**The job's token.** It is within reach of the code a run executes. It can
|
|
227
|
+
read this repository's contents and nothing else, and that is why this
|
|
228
|
+
workflow's `permissions` never grows.
|
|
229
|
+
|
|
230
|
+
## The terms
|
|
231
|
+
|
|
232
|
+
The maintainers agreed these terms. `test/macos-tests-workflow.test.mjs`
|
|
233
|
+
reads the workflow file and pins each one:
|
|
234
|
+
|
|
235
|
+
- `workflow_dispatch` is the only trigger;
|
|
236
|
+
- `permissions` is exactly `contents: read`; no secret is named; no artifact
|
|
237
|
+
is uploaded; no step saves or restores a cache;
|
|
238
|
+
- no input is written into a shell line: the ref and the file list reach the
|
|
239
|
+
script as environment variables;
|
|
240
|
+
- the checkout is the workflow's own commit, without its token left in the
|
|
241
|
+
checkout's configuration;
|
|
242
|
+
- the job has a timeout, and its concurrency group is its own and one per
|
|
243
|
+
run, so no later run cancels an earlier one.
|
|
244
|
+
|
|
245
|
+
Change a bound or a term with the maintainers' decision, and change this page
|
|
246
|
+
and that test in the same commit.
|
package/docs/official-catalog.md
CHANGED
|
@@ -9,10 +9,10 @@ or workspace membership alone does not make a package official.
|
|
|
9
9
|
|
|
10
10
|
| package | release | capabilities | package souls |
|
|
11
11
|
|---|---|---|---|
|
|
12
|
-
| `oats.framework` | `oats-framework/v1.
|
|
13
|
-
| `oats.okf` | `v5.0.
|
|
14
|
-
| `oats.aweb` | `v1.27.
|
|
15
|
-
| `oats.engineering` | `v1.9.
|
|
12
|
+
| `oats.framework` | `oats-framework/v1.10.0` (this repository) | `oats.core`, `oats.setup`, `oats.support`, `oats.knowledge-theory` | `knowledge-theory-expert` |
|
|
13
|
+
| `oats.okf` | `v5.0.3` | `oats.okf` (knowledge), `oats.okf-harvest`, `oats.okf-maintenance` | `knowledge-harvester`, `knowledge-maintainer` |
|
|
14
|
+
| `oats.aweb` | `v1.27.1` | `oats.aweb` (messaging) | |
|
|
15
|
+
| `oats.engineering` | `v1.9.1` | `oats.engineering-expert`, `oats.developer`, `oats.code-review`, `oats.maintainer` | `code-reviewer` |
|
|
16
16
|
| `oats.authoring` | `v1.0.3` | `oats.authoring` | |
|
|
17
17
|
| `oats.cloning` | `v1.0.1` | `oats.cloning` | `cloner` |
|
|
18
18
|
| `oats.jira` | `v1.0.1` | `oats.jira` (tasks) | |
|
|
@@ -29,7 +29,7 @@ no lock and adds nothing to an existing workspace.
|
|
|
29
29
|
## Find and use packages
|
|
30
30
|
|
|
31
31
|
- A workspace pins an official package by **bare version** in its
|
|
32
|
-
`packages:` map (`oats.okf: v5.0.
|
|
32
|
+
`packages:` map (`oats.okf: v5.0.3`); `oats sync` resolves it through the
|
|
33
33
|
catalog to an exact commit, fetches it, verifies its integrity and locks it.
|
|
34
34
|
A package outside the catalog is written `git:<repo>@<ref>`. Pinning does
|
|
35
35
|
not join a team or adopt the publisher's workspace. See
|
package/docs/packages.md
CHANGED
|
@@ -44,14 +44,14 @@ whole organisation:
|
|
|
44
44
|
|
|
45
45
|
```yaml
|
|
46
46
|
packages:
|
|
47
|
-
oats.okf: v5.0.
|
|
47
|
+
oats.okf: v5.0.3 # bare version → the official catalog
|
|
48
48
|
acme.tools: git:github.com/acme/tools@v0.4.0 # direct ref: git:<repo>@<tag or full OID>
|
|
49
49
|
```
|
|
50
50
|
|
|
51
|
-
- **Bare version** (`v5.0.
|
|
51
|
+
- **Bare version** (`v5.0.3`, `5.0.3`, `1.0.0-rc.1`): the id is looked up in
|
|
52
52
|
the official catalog — `package-catalog.json` in the `oats` repo, or the file
|
|
53
53
|
named by `OATS_PACKAGE_CATALOG` — which supplies the repo url, the tag
|
|
54
|
-
convention (`v5.0.
|
|
54
|
+
convention (`v5.0.3` or `oats-framework/v1.10.0`) and the payload path. An id
|
|
55
55
|
the catalog does not know is `E_PACKAGE_MISSING` ("use `git:<repo>@<ref>` for
|
|
56
56
|
a package outside the catalog"). The catalog is the reviewed official list
|
|
57
57
|
([official-catalog.md](official-catalog.md)) and the only way a
|
|
@@ -74,9 +74,9 @@ members:
|
|
|
74
74
|
- git:github.com/acme/agents
|
|
75
75
|
- git:github.com/acme/platform
|
|
76
76
|
packages:
|
|
77
|
-
oats.framework: v1.
|
|
78
|
-
oats.okf: v5.0.
|
|
79
|
-
oats.aweb: v1.27.
|
|
77
|
+
oats.framework: v1.10.0
|
|
78
|
+
oats.okf: v5.0.3
|
|
79
|
+
oats.aweb: v1.27.1
|
|
80
80
|
teams:
|
|
81
81
|
platform: { team: "platform:acme.aweb.ai", description: Platform engineering }
|
|
82
82
|
defaults:
|
|
@@ -105,7 +105,7 @@ decision recorded in the lock.
|
|
|
105
105
|
$ oats sync
|
|
106
106
|
workspace acme (github.com/acme/agents @ 3f2a9c1e)
|
|
107
107
|
members agents ✓↔ (@ 3f2a9c1e) platform ✓↔ (@ 77c0a1b2) billing ✗ (no-backlink)
|
|
108
|
-
packages acme.tools 0.4.0 ✓ (@ 47f4b816) oats.okf 5.0.
|
|
108
|
+
packages acme.tools 0.4.0 ✓ (@ 47f4b816) oats.okf 5.0.3 ✓ (@ e687a94a)
|
|
109
109
|
changed acme.tools — → 0.4.0 (@ 47f4b816)
|
|
110
110
|
souls 9 discovered (6 members, 1 external, 2 package, 0 disabled here) · 0 private capabilities
|
|
111
111
|
teams platform (shared) · this deployment's: oats teams
|
|
@@ -134,7 +134,7 @@ Declaring a package in the workspace's `packages:` is the trust decision
|
|
|
134
134
|
## `oats package add | remove`
|
|
135
135
|
|
|
136
136
|
```bash
|
|
137
|
-
oats package add oats.aweb v1.27.
|
|
137
|
+
oats package add oats.aweb v1.27.1 # a catalog version
|
|
138
138
|
oats package add acme.tools git:github.com/acme/tools@v0.4.0
|
|
139
139
|
oats package remove acme.tools
|
|
140
140
|
```
|
|
@@ -160,8 +160,8 @@ same workspace commit hold identical locks.
|
|
|
160
160
|
"source": "catalog:oats.okf",
|
|
161
161
|
"url": "https://github.com/awebai/oats-okf.git",
|
|
162
162
|
"path": "oats-package",
|
|
163
|
-
"version": "5.0.
|
|
164
|
-
"commit": "
|
|
163
|
+
"version": "5.0.3",
|
|
164
|
+
"commit": "e687a94a40494521a671979dd168e3d62b11bcde",
|
|
165
165
|
"integrity": "sha256-…",
|
|
166
166
|
"capabilities": ["oats.okf", "oats.okf-harvest", "oats.okf-maintenance"]
|
|
167
167
|
},
|
|
@@ -352,12 +352,12 @@ A soul that names one of the package's capabilities with
|
|
|
352
352
|
{
|
|
353
353
|
"policy": "docs/official-catalog.md",
|
|
354
354
|
"packages": {
|
|
355
|
-
"oats.okf": { "url": "https://github.com/awebai/oats-okf.git", "ref": "v5.0.
|
|
356
|
-
"oats.framework": { "url": "https://github.com/awebai/oats.git", "ref": "oats-framework/v1.
|
|
355
|
+
"oats.okf": { "url": "https://github.com/awebai/oats-okf.git", "ref": "v5.0.3", "path": "oats-package" },
|
|
356
|
+
"oats.framework": { "url": "https://github.com/awebai/oats.git", "ref": "oats-framework/v1.10.0", "path": "oats-package" }
|
|
357
357
|
}
|
|
358
358
|
}
|
|
359
359
|
```
|
|
360
360
|
|
|
361
|
-
`ref` carries the tag convention: a workspace's `oats.framework: v1.
|
|
362
|
-
resolves to tag `oats-framework/v1.
|
|
361
|
+
`ref` carries the tag convention: a workspace's `oats.framework: v1.10.0`
|
|
362
|
+
resolves to tag `oats-framework/v1.10.0`. Resolving through the catalog never
|
|
363
363
|
advances a lock by itself: `oats sync` does, and says so.
|
package/docs/release-lane.md
CHANGED
|
@@ -9,8 +9,9 @@ The policy it satisfies: no release capability may permanently depend on
|
|
|
9
9
|
GitHub or GitHub Actions. Registry publish works on its own; tags and hosted
|
|
10
10
|
release assets can follow later.
|
|
11
11
|
|
|
12
|
-
The
|
|
13
|
-
released `oats.okf
|
|
12
|
+
The sections after the lane's own cover release-notes entries, the
|
|
13
|
+
post-publish Desktop check, mirroring a released `oats.okf` and releasing
|
|
14
|
+
`oats.framework`.
|
|
14
15
|
|
|
15
16
|
## When to use it
|
|
16
17
|
|
|
@@ -27,13 +28,15 @@ released `oats.okf`.
|
|
|
27
28
|
|
|
28
29
|
Every phase takes `--tag vX.Y.Z` and reads or writes `stage/<tag>/`
|
|
29
30
|
(gitignored; `--stage <dir>` overrides). `MANIFEST.json` there records the
|
|
30
|
-
SHA, the
|
|
31
|
+
SHA, the Node and npm versions it was built with (`node`, `npmVersion`), the
|
|
32
|
+
tarballs and their digests (`npm.tarballs`), the assets, and which phases
|
|
33
|
+
completed.
|
|
31
34
|
Every external command is printed before it runs and its output is logged
|
|
32
35
|
under `stage/<tag>/logs/`; a failing step exits non-zero with the log path.
|
|
33
36
|
|
|
34
37
|
| Phase | Mirrors in `release.yml` | Writes |
|
|
35
38
|
| --- | --- | --- |
|
|
36
|
-
| `build --tag vX.Y.Z [--sha <commit>]` | jobs `build-and-test` and `tests` (the lane runs the suite unsharded): notes gate, three-manifest bump, `node --check`, `npm ci`, `npm run check`, Desktop test deps, `npm test`, `pack:check` and the tarball greps, `smoke:tarball`, the `version --json` probe | `npm/*.tgz`, `MANIFEST.json` |
|
|
39
|
+
| `build --tag vX.Y.Z [--sha <commit>]` | jobs `build-and-test` and `tests` (the lane runs the suite unsharded): notes gate, unassembled-entries gate, three-manifest bump, `node --check`, `npm ci`, `npm run check`, Desktop test deps, `npm test`, `pack:check` and the tarball greps, `smoke:tarball`, the `version --json` probe | `npm/*.tgz`, `MANIFEST.json` |
|
|
37
40
|
| `desktop --tag vX.Y.Z --arch arm64\|x64` | one `desktop-build` matrix leg: desktop `npm ci`, `npm test`, `npm run dist -- --<arch>`, strict deep `codesign --verify` (macOS), `dist:smoke` in build-verify mode | `assets/oats-desktop-*` |
|
|
38
41
|
| `stage --tag vX.Y.Z` | publish job, "Checksums" (`shasum -a 256`) | `assets/SHA256SUMS.txt` |
|
|
39
42
|
| `publish-npm --tag vX.Y.Z [--dry-run] --yes` | publish job, the two guarded `npm publish --access public` steps, kernel then adapter | — |
|
|
@@ -59,7 +62,9 @@ through `NPM_CONFIG_USERCONFIG` and deleted afterwards, never into the repo.
|
|
|
59
62
|
## A full release from a Mac plus a Linux host
|
|
60
63
|
|
|
61
64
|
Release notes must exist at `docs/release-notes/<tag>.md` on the commit being
|
|
62
|
-
released,
|
|
65
|
+
released, with no entry file left under `docs/release-notes/next/`
|
|
66
|
+
([Release-notes entries](#release-notes-entries)), and the commit must be on
|
|
67
|
+
`origin/main`. On the Mac:
|
|
63
68
|
|
|
64
69
|
```bash
|
|
65
70
|
git fetch origin
|
|
@@ -123,6 +128,13 @@ Everything after `build` reads `MANIFEST.json` and the files already staged:
|
|
|
123
128
|
so no checks run on it by themselves; close and reopen it to run them, and
|
|
124
129
|
do not read missing checks as green. Open the PR by hand if the workflow
|
|
125
130
|
does not run.
|
|
131
|
+
- **The accepted range also decides which kernel `oats tui` accepts.**
|
|
132
|
+
`ACCEPT_RANGE` (`packages/client/cli-locator.mjs`) is read by the Desktop
|
|
133
|
+
and by the terminal client, which runs the kernel it ships with: a bump
|
|
134
|
+
that leaves the new version outside the range ships an `oats tui` that
|
|
135
|
+
stops at its start with `E_TUI_KERNEL`. The test "the accepted band admits
|
|
136
|
+
the kernel version this Desktop ships with"
|
|
137
|
+
(`packages/desktop/test/cli-locator.test.mjs`) fails for such a bump.
|
|
126
138
|
- **Legs for hosts you do not have.** The Linux AppImage/DEB need a Linux
|
|
127
139
|
host; the lane says so and `stage` lists what is missing.
|
|
128
140
|
- **The packaged window launch.** `release.yml` launches the packaged window
|
|
@@ -143,6 +155,196 @@ logic against fixtures, with `npm` stubbed. The two can run in either order:
|
|
|
143
155
|
a lane release followed by a workflow run, or a broken workflow run finished
|
|
144
156
|
by the lane, and neither republishes what the other already did.
|
|
145
157
|
|
|
158
|
+
## The workflow's actions are named by commit
|
|
159
|
+
|
|
160
|
+
`release.yml` holds the publishing rights, so it names every action it uses
|
|
161
|
+
by a full commit id, with the exact version in a comment beside it:
|
|
162
|
+
|
|
163
|
+
```yaml
|
|
164
|
+
- uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4.4.0
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
A tag is the action owner's to move, and a commit is not: the code that runs
|
|
168
|
+
with the publishing rights is the code that was read. `build-installers.yml`
|
|
169
|
+
runs the same installer steps, so it names the same commits. Every other
|
|
170
|
+
workflow keeps tags (`actions/checkout@v4`): nothing is published from them.
|
|
171
|
+
|
|
172
|
+
`test/workflow-no-cache.test.mjs` holds this. Its table of the actions that
|
|
173
|
+
were read has a row for each action: `action`, `id`, `version`. In the two files
|
|
174
|
+
every `uses:` is a row's id, the same action is the same id in both, and the
|
|
175
|
+
comment beside an id is the row's version. In every other workflow a `uses:`
|
|
176
|
+
is the major of a row's version.
|
|
177
|
+
|
|
178
|
+
**An id is moved by a pull request, reviewed like any change to that
|
|
179
|
+
workflow.** It changes these together, and nothing else in the two workflow
|
|
180
|
+
files:
|
|
181
|
+
|
|
182
|
+
- the id and the version comment, on every `uses:` line of that action in
|
|
183
|
+
`release.yml` and `build-installers.yml`;
|
|
184
|
+
- the action's row in the table.
|
|
185
|
+
|
|
186
|
+
**The id is read from an exact version tag of the action's own repository**
|
|
187
|
+
(`v4.4.0`, not the moving `v4`). For an annotated tag it is the commit the tag
|
|
188
|
+
object points at:
|
|
189
|
+
|
|
190
|
+
```bash
|
|
191
|
+
gh api repos/actions/checkout/git/ref/tags/v4.4.0 --jq '.object.type, .object.sha'
|
|
192
|
+
# type `commit`: that is the id. Type `tag`: the id is the tag object's commit:
|
|
193
|
+
gh api repos/actions/checkout/git/tags/<sha of the tag object> --jq '.object.sha'
|
|
194
|
+
|
|
195
|
+
# The same with git. For an annotated tag, the line that ends in ^{} has the id.
|
|
196
|
+
git ls-remote https://github.com/actions/checkout refs/tags/v4.4.0 'refs/tags/v4.4.0^{}'
|
|
197
|
+
```
|
|
198
|
+
|
|
199
|
+
Never take an id because it resolves, and never copy one from another
|
|
200
|
+
project's workflow. GitHub resolves `owner/action@<id>` for a commit of any
|
|
201
|
+
fork of that action, so an id that works says nothing about whose commit it
|
|
202
|
+
is. The pull request gives, for each id it moves, the tag, the id and the
|
|
203
|
+
command that read it, so that its reviewer repeats the reading.
|
|
204
|
+
|
|
205
|
+
**The commit is read before its row is written**, for whether the action
|
|
206
|
+
saves or restores an Actions cache by itself: its `action.yml`, the actions
|
|
207
|
+
and packages it depends on, and what its entry points call of a cache.
|
|
208
|
+
|
|
209
|
+
- A composite action names other actions. Check, at the id, that its inner
|
|
210
|
+
`uses:` are full commit ids too: then the outer id fixes them.
|
|
211
|
+
- A version of `actions/setup-node` that caches by itself (v5 and later)
|
|
212
|
+
needs `package-manager-cache: false` on every step. The test takes the
|
|
213
|
+
version of an id from the row, so it refuses a step without it.
|
|
214
|
+
|
|
215
|
+
**The two files name their runners by version too** (`ubuntu-24.04`, as they
|
|
216
|
+
name `macos-14`), never by a label that GitHub moves to another system by
|
|
217
|
+
itself (`ubuntu-latest`). The Linux installers are built on that runner, and
|
|
218
|
+
what they need of a system follows the system that built them.
|
|
219
|
+
`pull-request.yml` keeps `ubuntu-latest` on purpose: when the label moves, a
|
|
220
|
+
break on the new system shows in pull-request CI first and not at a release.
|
|
221
|
+
|
|
222
|
+
The labels the two files may name are a list beside the table of actions in
|
|
223
|
+
`test/workflow-no-cache.test.mjs`: `ubuntu-24.04` and `macos-14`. Every job
|
|
224
|
+
of the two files runs on a label of that list, and both files build on the
|
|
225
|
+
same Linux. A label is added to the list by whoever decides the runner, as an
|
|
226
|
+
action's row is by whoever read it.
|
|
227
|
+
|
|
228
|
+
**Moving the runner is a pull request** that changes the label in the two
|
|
229
|
+
files and in the list together, and says what the installers then need.
|
|
230
|
+
|
|
231
|
+
**What the Linux installer needs today**, to compare with at the next move.
|
|
232
|
+
Read from `oats-desktop-0.52.0-linux-amd64.deb`, built on `ubuntu-24.04`
|
|
233
|
+
(sha256
|
|
234
|
+
`a6148c8a7b49404d73e46c81523568accc560843ed2fab0c54ca501f09c481b7`):
|
|
235
|
+
|
|
236
|
+
| part of the DEB | highest glibc symbol version it needs |
|
|
237
|
+
|---|---|
|
|
238
|
+
| the Electron binary, `oats-desktop` | `GLIBC_2.25` |
|
|
239
|
+
| the native module, `node-pty`'s `pty.node` | `GLIBC_2.34` |
|
|
240
|
+
|
|
241
|
+
```bash
|
|
242
|
+
ar x oats-desktop-<version>-linux-amd64.deb && tar -xf data.tar.xz
|
|
243
|
+
# for the binary and for each native module under resources/app.asar.unpacked:
|
|
244
|
+
objdump -T <file> | grep -o 'GLIBC_[0-9.]*' | sort -uV | tail -1
|
|
245
|
+
```
|
|
246
|
+
|
|
247
|
+
Nothing of the package is run to read it. The numbers are what the DEB's files
|
|
248
|
+
ask of the system's glibc, not a floor anybody tested on an older system. The
|
|
249
|
+
AppImage, built in the same leg from the same build, was not read. The
|
|
250
|
+
module's number follows the runner that builds it: the symbols it needs at
|
|
251
|
+
2.34 are the ones a module gets when it is built on a system whose glibc is
|
|
252
|
+
2.34 or later.
|
|
253
|
+
|
|
254
|
+
## Release-notes entries
|
|
255
|
+
|
|
256
|
+
A release ships one notes file, `docs/release-notes/v<version>.md`. Between
|
|
257
|
+
releases a pull request does not write its entry into it: it adds its entry
|
|
258
|
+
as a file of its own, and one command moves the entries into the notes file
|
|
259
|
+
in the release-prep pull request. Two pull requests that share no code
|
|
260
|
+
therefore never conflict over their entries.
|
|
261
|
+
|
|
262
|
+
### For the author of a pull request
|
|
263
|
+
|
|
264
|
+
- **One file, `docs/release-notes/next/<name>.md`**, added by the pull
|
|
265
|
+
request that makes the change. The entry does not go into
|
|
266
|
+
`docs/release-notes/v<next>.md`, which a pull request touches for one
|
|
267
|
+
reason only, the next point.
|
|
268
|
+
- **Correcting an unreleased entry.** A pull request that makes an existing
|
|
269
|
+
unreleased entry untrue corrects that entry where it stands: in the
|
|
270
|
+
unreleased notes file, or in the entry file of the earlier pull request
|
|
271
|
+
while that file is still under `docs/release-notes/next/`. It adds its own
|
|
272
|
+
entry in its own entry file. In the earlier entry it changes only the
|
|
273
|
+
sentences it makes untrue, and its description names them. A released notes
|
|
274
|
+
file is never corrected this way.
|
|
275
|
+
- **The name** is the issue's number and a short slug:
|
|
276
|
+
`991-update-every-pi-folder.md`. Lower-case letters, digits and hyphens,
|
|
277
|
+
then `.md`. The number is a convention: nothing reads the name but the
|
|
278
|
+
order of assembly.
|
|
279
|
+
- **The content is a piece of the notes file:** one or more `## <Section>`
|
|
280
|
+
headings, each followed by its entries, and nothing else. No title, no text
|
|
281
|
+
before the first heading. Write the entry as it will read in the notes
|
|
282
|
+
file. The sections, in the notes file's order, are `Upgrade`, `Added`,
|
|
283
|
+
`Changed`, `Fixed`, `Removed`, `Provider updates` and `Documentation`. A
|
|
284
|
+
heading is one of them exactly, from the first column.
|
|
285
|
+
- **Links are written for `docs/release-notes/`**, the directory the text
|
|
286
|
+
moves into: a link to `docs/tui.md` has the target `../tui.md`.
|
|
287
|
+
`npm run validate` resolves an entry file's links from that directory. Such
|
|
288
|
+
a link does not resolve when the entry file is opened on its own in a
|
|
289
|
+
browser.
|
|
290
|
+
- **`test/release-notes-entries.test.mjs` holds every entry file on the tree
|
|
291
|
+
to these rules:** the name; a regular file directly in the directory; only
|
|
292
|
+
the seven sections, each at most once; at least one non-blank line under
|
|
293
|
+
each heading; no `# ` title; every fenced block closed. A `## ` line inside
|
|
294
|
+
a fenced block is text.
|
|
295
|
+
- **The directory exists only while it holds entries.** It has no README and
|
|
296
|
+
no placeholder: anything in it counts as an unassembled entry.
|
|
297
|
+
|
|
298
|
+
### For the tag owner
|
|
299
|
+
|
|
300
|
+
```bash
|
|
301
|
+
node scripts/assemble-release-notes.mjs --tag v0.54.0
|
|
302
|
+
```
|
|
303
|
+
|
|
304
|
+
- **It moves every entry into `docs/release-notes/v0.54.0.md`** and removes
|
|
305
|
+
the entry files and the emptied directory. A notes file that does not exist
|
|
306
|
+
is created, with the title `# OATS 0.54.0` and the line `Unreleased`.
|
|
307
|
+
`--root <dir>` works in another tree.
|
|
308
|
+
- **Order.** Files are taken by name as plain strings, what `LC_ALL=C ls`
|
|
309
|
+
prints: `1002-…` comes before `996-…`. In each section a file's text goes
|
|
310
|
+
after what the section already holds. A section the notes file lacks is
|
|
311
|
+
created at its place in the order above. A heading that is not one of the
|
|
312
|
+
seven, such as a hand-written highlight, stays where it is.
|
|
313
|
+
- **It moves text and rewrites none.** Every line it did not add is kept as
|
|
314
|
+
it is, except blank lines where text goes in. It sets no date in place of
|
|
315
|
+
`Unreleased` and sorts nothing inside a section: reorder entries by hand in
|
|
316
|
+
the prep pull request, where the result is reviewed as a diff.
|
|
317
|
+
- **All or nothing.** With a problem in any entry, or a notes file that holds
|
|
318
|
+
a section twice or a fenced block that is never closed, it prints every
|
|
319
|
+
problem, writes nothing, removes nothing and exits 2.
|
|
320
|
+
- **An interrupted run.** The command writes the notes file first and removes
|
|
321
|
+
the entry files after it. A run that stops in between leaves entry files
|
|
322
|
+
beside a notes file that already holds their text, and a second run would
|
|
323
|
+
add that text again. Put the tree back first, one of two ways: delete the
|
|
324
|
+
entry files that are left, whose text the notes file holds, and the run is
|
|
325
|
+
complete; or return all of `docs/release-notes/` to what Git has, which is
|
|
326
|
+
the notes file (deleted, if this run created it) and the entry files
|
|
327
|
+
already removed, and run the command again. A run that stops before it
|
|
328
|
+
writes the notes file has changed neither; at most it leaves a `.tmp` file
|
|
329
|
+
beside the notes file.
|
|
330
|
+
- **Running it more than once in a release is normal.** The pull request that
|
|
331
|
+
moves the manifests to a new version runs it to create that version's notes
|
|
332
|
+
file, which `test/release-packaging.test.mjs` requires for the version the
|
|
333
|
+
manifests carry. The release-prep pull request runs it again for the
|
|
334
|
+
entries merged since, which go after the earlier ones.
|
|
335
|
+
- **A tag is refused while anything is under `docs/release-notes/next/`:** by
|
|
336
|
+
the `build-and-test` job of `release.yml` and by `release-lane.mjs build`,
|
|
337
|
+
each right after its notes-file gate and before anything is built. Each
|
|
338
|
+
names the command to run. The kernel package carries all of `docs/`, so
|
|
339
|
+
these two gates are also what keeps an unassembled entry out of a published
|
|
340
|
+
tarball.
|
|
341
|
+
|
|
342
|
+
### When it starts
|
|
343
|
+
|
|
344
|
+
When the change that adds this section is on `main`. Entries already in
|
|
345
|
+
`docs/release-notes/v0.53.0.md` stay there. A pull request in flight that has
|
|
346
|
+
to rebase for the notes anyway may move its entry into a file at that rebase.
|
|
347
|
+
|
|
146
348
|
## Desktop release verification
|
|
147
349
|
|
|
148
350
|
Installer CI gates what headless runners can prove reliably for every
|
|
@@ -247,7 +449,9 @@ When the diff is not empty:
|
|
|
247
449
|
|
|
248
450
|
1. **The framework prep PR.** Bump `version` in the `oats.json` of each
|
|
249
451
|
changed capability and in `oats-package/oats-package.json`, and add the
|
|
250
|
-
release-notes entry
|
|
452
|
+
release-notes entry as a file under `docs/release-notes/next/`
|
|
453
|
+
([Release-notes entries](#release-notes-entries)). Read the skill lines
|
|
454
|
+
added since the last tag: a
|
|
251
455
|
command or behaviour that an older kernel the capability still admits does
|
|
252
456
|
not have names the version it starts in. Guidance text alone does not
|
|
253
457
|
raise a capability's `compatibility.oats`.
|