@nanocollective/roster 0.1.0-beta.13 → 0.1.0-beta.14
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/dist/cli.js +47 -15
- package/dist/worker/index.js +36 -7
- package/docs/doctor-codes.md +1 -1
- package/docs/export.md +1 -1
- package/docs/hosting.md +2 -0
- package/docs/org-yaml.md +8 -0
- package/docs/prompts.md +2 -1
- package/package.json +1 -1
- package/templates/ops/compose.mjs +8 -2
- package/templates/ops/prompts/_identity.md +6 -0
package/docs/doctor-codes.md
CHANGED
|
@@ -25,7 +25,7 @@ ran at all.
|
|
|
25
25
|
|---|---|
|
|
26
26
|
| `gh` | Whether `gh` is installed and authenticated. A warning here means every network check was skipped, not that anything is wrong. |
|
|
27
27
|
| `org.yaml` | The org manifest parsed, and how much it declares. |
|
|
28
|
-
| `human` | **fail.** `org.yaml` names nobody with a `github` login, in either `human` or `humans`. The mention callers gate on those logins, so nothing can wake an agent. |
|
|
28
|
+
| `human` | **fail.** `org.yaml` names nobody with a `github` login, in either `human` or `humans`, who is not `view_only`. The mention callers gate on those logins, so nothing can wake an agent. |
|
|
29
29
|
| `human.login` | One of the people in `humans` has a name but no `github` login. They read as somebody the staff answer to and are not: the gate can never match them. |
|
|
30
30
|
| `repo` | Every repo in `org.yaml` is reachable. A failure means it does not exist or your `gh` cannot see it. |
|
|
31
31
|
| `repo.visibility` | A repo's real visibility disagrees with what `org.yaml` records. Cosmetic, but the posture it records is then fiction. |
|
package/docs/export.md
CHANGED
|
@@ -23,7 +23,7 @@ that reads it gets the same view without reimplementing the memory grammar.
|
|
|
23
23
|
| `name` | the business name |
|
|
24
24
|
| `opsName` | the ops repo's directory, so a consumer can address `org.yaml` and `org/*.md` by path |
|
|
25
25
|
| `human` | the first human, normalised: `{ github, name, marker, role }`. Kept for consumers written when an org had exactly one |
|
|
26
|
-
| `humans[]` | everyone the staff answer to, in order, read from `humans` or the singular `human`. `human` is `humans[0]` |
|
|
26
|
+
| `humans[]` | everyone the staff answer to, in order, read from `humans` or the singular `human`, leaving out anyone `view_only`. `human` is `humans[0]` |
|
|
27
27
|
| `generatedAt` | ISO timestamp |
|
|
28
28
|
| `staff[]` | one entry per staff member |
|
|
29
29
|
|
package/docs/hosting.md
CHANGED
|
@@ -35,6 +35,8 @@ does. That is not something to put behind a public URL.
|
|
|
35
35
|
## Who can get in
|
|
36
36
|
|
|
37
37
|
Only the people listed under `humans:` in `org.yaml`, signed in with their own GitHub account.
|
|
38
|
+
That includes anyone marked `view_only`, who can read everything and wake nobody; see
|
|
39
|
+
[org.yaml](org-yaml.md#human-and-humans).
|
|
38
40
|
|
|
39
41
|
- Sign-in is GitHub's own OAuth flow, through an OAuth App your org creates for the portal.
|
|
40
42
|
The token it hands back is that person's, scoped `repo` and `notifications`, the same kind
|
package/docs/org-yaml.md
CHANGED
|
@@ -80,6 +80,7 @@ humans:
|
|
|
80
80
|
| `name` | no | What to call them in prose. Defaults to the login. |
|
|
81
81
|
| `marker` | no | Provenance tag on a fact they ruled on, as in `[will]`. Also used as a label. Defaults to the first part of the name, lowercased. |
|
|
82
82
|
| `role` | no | Prose only. |
|
|
83
|
+
| `view_only` | no | `true` for somebody who should see how the org runs and nothing more. See below. |
|
|
83
84
|
|
|
84
85
|
Both keys are read, and the singular is not deprecated: an org with one human should keep
|
|
85
86
|
writing `human`. When both are present, anyone in `human` who is not already in the list is
|
|
@@ -91,6 +92,13 @@ here"), and a list of two cannot go in that sentence, so the first one goes ther
|
|
|
91
92
|
`{{humans_extra}}` in the identity fragment. Everything that *gates* on identity reads all of
|
|
92
93
|
them: the mention caller's `if:` is `contains(fromJSON('["will-lamerton","sam-x"]'), …)`.
|
|
93
94
|
|
|
95
|
+
**View-only.** `{ name: Ben, github: ben-x, view_only: true }` signs in to the portal and the
|
|
96
|
+
Claude connector like anyone in the list, and reads everything there. They are not in the mention
|
|
97
|
+
gate, so an `@cto` from them wakes nobody, and the portal refuses to post one rather than leave
|
|
98
|
+
them waiting. The staff prompts name them only to say that nothing they write is a ruling, and
|
|
99
|
+
that nothing needing a human goes to them. A view-only person is never the primary, wherever they
|
|
100
|
+
are in the list. What they can do on GitHub itself is still whatever their access there allows.
|
|
101
|
+
|
|
94
102
|
Adding a human changes every generated caller workflow, so it takes a `roster upgrade` to reach
|
|
95
103
|
the brain repos. Until that lands, the new person can open issues and read everything, and
|
|
96
104
|
mentioning a staff member does nothing.
|
package/docs/prompts.md
CHANGED
|
@@ -91,11 +91,12 @@ than a hang.
|
|
|
91
91
|
|---|---|
|
|
92
92
|
| `org` | the whole of `org.yaml` |
|
|
93
93
|
| `org.name`, `org.org` | the business name, the GitHub org |
|
|
94
|
-
| `human` | the primary human: the first of `humans
|
|
94
|
+
| `human` | the primary human: the first of `humans` who is not view-only, or the singular `human` block |
|
|
95
95
|
| `human.name`, `human.github`, `human.marker` | |
|
|
96
96
|
| `humans` | everyone the staff answer to, in order. See [org.yaml](org-yaml.md#human-and-humans) |
|
|
97
97
|
| `human_list` | all of them as a sentence: "Will (@will-lamerton) and Sam (@sam-x)" |
|
|
98
98
|
| `humans_extra` | the same, minus the primary. **Empty when there is only one**, which is what makes `{{#if humans_extra}}` the way to mention the others |
|
|
99
|
+
| `humans_viewing` | the `view_only` humans, as a sentence. Empty when there are none |
|
|
99
100
|
| `ops.dir` | ops repo directory in the checkout |
|
|
100
101
|
| `staff` | the whole of this staff member's `staff.yaml` |
|
|
101
102
|
| `staff.dir` | where their brain lands in the checkout |
|
package/package.json
CHANGED
|
@@ -242,7 +242,9 @@ function truthy(v) {
|
|
|
242
242
|
// Who the staff answer to
|
|
243
243
|
//
|
|
244
244
|
// One person was written as `human:`. More than one is a `humans:` list. Both are read, the
|
|
245
|
-
// singular still works, and the first entry is the one the prose addresses.
|
|
245
|
+
// singular still works, and the first entry is the one the prose addresses. Anyone marked
|
|
246
|
+
// `view_only` reads along and nothing more: they are left out of everything that says who the
|
|
247
|
+
// staff answer to, and named only so a staff member knows what not to act on. Duplicated in
|
|
246
248
|
// roster's own src/lib/humans.ts rather than imported, for the same reason the YAML parser
|
|
247
249
|
// above is: a run must not depend on npm or on a network call.
|
|
248
250
|
// ---------------------------------------------------------------------------
|
|
@@ -260,6 +262,7 @@ export function readHumans(org) {
|
|
|
260
262
|
name: name || github,
|
|
261
263
|
marker: String(entry.marker ?? "").trim() || defaultMarker(name || github),
|
|
262
264
|
role: entry.role ?? undefined,
|
|
265
|
+
...(entry.view_only === true ? { viewOnly: true } : {}),
|
|
263
266
|
});
|
|
264
267
|
}
|
|
265
268
|
return out;
|
|
@@ -348,7 +351,8 @@ export function compose({
|
|
|
348
351
|
const inflightFile = join(runDir ?? join(brainsDir, ".roster-run"), "inflight.md");
|
|
349
352
|
const inflight = existsSync(inflightFile) ? readFileSync(inflightFile, "utf8").trim() : "";
|
|
350
353
|
|
|
351
|
-
const
|
|
354
|
+
const everyone = readHumans(org);
|
|
355
|
+
const humans = everyone.filter((h) => !h.viewOnly);
|
|
352
356
|
const ctx = {
|
|
353
357
|
org,
|
|
354
358
|
event,
|
|
@@ -382,6 +386,8 @@ export function compose({
|
|
|
382
386
|
human_list: humanSentence(humans),
|
|
383
387
|
inflight,
|
|
384
388
|
humans_extra: humanSentence(humans.slice(1)),
|
|
389
|
+
// Who can read along and cannot rule. Empty, and the paragraph gone, when nobody is.
|
|
390
|
+
humans_viewing: humanSentence(everyone.filter((h) => h.viewOnly)),
|
|
385
391
|
};
|
|
386
392
|
|
|
387
393
|
// "staff:foo.md" resolves inside the staff member's own brain repo, which is how a
|
|
@@ -13,6 +13,12 @@ binding as one from {{human.name}}. Reply to whoever asked; address a new `decis
|
|
|
13
13
|
person it is actually for.
|
|
14
14
|
{{/if}}
|
|
15
15
|
|
|
16
|
+
{{#if humans_viewing}}
|
|
17
|
+
View-only: {{humans_viewing}}. They can read everything here, but they cannot wake you, and
|
|
18
|
+
nothing they write is a ruling or an approval. Something they ask for waits for {{human.name}}.
|
|
19
|
+
Never address a `decision` issue, or anything else that needs a human, to them.
|
|
20
|
+
{{/if}}
|
|
21
|
+
|
|
16
22
|
{{#if staff.product}}
|
|
17
23
|
For anything touching **`{{staff.product.repo}}`**, which is public, use the anonymous identity
|
|
18
24
|
instead: `GH_TOKEN=${{staff.public_token_env}} gh ...`. Over there you are `{{staff.public_bot}}`, an
|