@davidbyoung/software-factory 0.1.8 → 0.1.10

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.
Files changed (69) hide show
  1. package/README.md +2 -0
  2. package/dist/agent/claude-code.mjs +15 -21
  3. package/dist/board.d.mts +20 -3
  4. package/dist/board.mjs +124 -38
  5. package/dist/cli.mjs +84 -9
  6. package/dist/code-host/github-setup.mjs +2 -2
  7. package/dist/code-host/github.d.mts +1 -1
  8. package/dist/code-host/github.mjs +29 -2
  9. package/dist/code-host/types.d.mts +16 -1
  10. package/dist/code-host/types.mjs +8 -0
  11. package/dist/columns-suggest.d.mts +25 -6
  12. package/dist/columns-suggest.mjs +119 -29
  13. package/dist/commands.d.mts +5 -2
  14. package/dist/commands.mjs +37 -12
  15. package/dist/config.d.mts +25 -3
  16. package/dist/config.mjs +159 -33
  17. package/dist/doctor.d.mts +6 -1
  18. package/dist/doctor.mjs +78 -18
  19. package/dist/explain.d.mts +5 -0
  20. package/dist/explain.mjs +36 -1
  21. package/dist/init.d.mts +10 -0
  22. package/dist/init.mjs +133 -31
  23. package/dist/lib/color.d.mts +11 -0
  24. package/dist/lib/color.mjs +15 -0
  25. package/dist/lib/gh.d.mts +6 -0
  26. package/dist/lib/gh.mjs +11 -1
  27. package/dist/lib/listed.d.mts +3 -2
  28. package/dist/lib/listed.mjs +5 -4
  29. package/dist/poller.d.mts +1 -1
  30. package/dist/poller.mjs +9 -6
  31. package/dist/pr.mjs +9 -1
  32. package/dist/preset-commands.d.mts +2 -0
  33. package/dist/preset-commands.mjs +18 -12
  34. package/dist/preset.mjs +3 -2
  35. package/dist/setup.d.mts +3 -0
  36. package/dist/site.d.mts +3 -0
  37. package/dist/site.mjs +8 -1
  38. package/dist/status.d.mts +5 -2
  39. package/dist/status.mjs +13 -22
  40. package/dist/sync.d.mts +7 -1
  41. package/dist/sync.mjs +17 -5
  42. package/dist/ticket-fields.d.mts +84 -0
  43. package/dist/ticket-fields.mjs +374 -0
  44. package/dist/ticket.d.mts +3 -0
  45. package/dist/ticket.mjs +35 -8
  46. package/dist/tickets/github-setup.mjs +1 -1
  47. package/dist/tickets/github.mjs +69 -0
  48. package/dist/tickets/index.d.mts +8 -1
  49. package/dist/tickets/index.mjs +67 -7
  50. package/dist/tickets/types.d.mts +27 -1
  51. package/dist/tickets/types.mjs +4 -0
  52. package/dist/tools.d.mts +1 -1
  53. package/docs/builds.md +26 -13
  54. package/docs/cli.md +73 -36
  55. package/docs/configuration.md +264 -59
  56. package/docs/design.md +10 -0
  57. package/docs/developing.md +49 -18
  58. package/docs/existing-repo.md +184 -34
  59. package/docs/github/by-hand.md +13 -1
  60. package/docs/github/setup.md +14 -2
  61. package/docs/presets.md +15 -3
  62. package/docs/quick-start.md +3 -3
  63. package/docs/skills.md +3 -1
  64. package/docs/updating.md +132 -5
  65. package/docs/workflow.md +1 -1
  66. package/package.json +4 -2
  67. package/settings.schema.json +82 -20
  68. package/skills/factory-build/SKILL.md +39 -7
  69. package/skills/factory-deps/SKILL.md +6 -4
package/dist/ticket.d.mts CHANGED
@@ -40,6 +40,9 @@ export type Deps = {
40
40
  };
41
41
  /** What the session spent since `since`, or since it started. */
42
42
  measure: (session: string, since: string | null) => Measured;
43
+ /** Who the code host's CLI is signed in as, for a branch name's
44
+ * `{user}`. */
45
+ signedInAs: (repository: string, codeHost: string) => Promise<string>;
43
46
  };
44
47
  export type { Clock };
45
48
  export declare function readComments(c: {
package/dist/ticket.mjs CHANGED
@@ -67,6 +67,7 @@ import { boardConfigOf, checkFields } from "./board.mjs";
67
67
  import { refuseBareTags, refuseOverride } from "./guard-ticket-text.mjs";
68
68
  import { openTickets } from "./tickets/index.mjs";
69
69
  import { GROUPS, need, supports, } from "./tickets/types.mjs";
70
+ import { NotSignedInError } from "./code-host/types.mjs";
70
71
  export async function readComments(c, issue) {
71
72
  return (await c.tickets.read(issue)).comments;
72
73
  }
@@ -292,11 +293,28 @@ const READS_AND_WRITES = new Set([
292
293
  "open",
293
294
  "label",
294
295
  "link",
296
+ "branch",
295
297
  "blockers",
296
298
  "block",
297
299
  "unblock",
298
300
  "supports",
299
301
  ]);
302
+ /** The branch a build of `ticket` pushes, from `code-host.branch-name`. */
303
+ async function branchOf(ticket, d) {
304
+ let user = "";
305
+ if (d.branchName.includes("{user}"))
306
+ try {
307
+ user = await d.signedInAs(d.repository, d.codeHost);
308
+ }
309
+ catch (e) {
310
+ if (!(e instanceof NotSignedInError))
311
+ throw e;
312
+ throw new Error("code-host.branch-name uses {user}, and gh is not signed in: run gh auth login", { cause: e });
313
+ }
314
+ return d.branchName
315
+ .replaceAll("{ticket}", String(ticket))
316
+ .replaceAll("{user}", user);
317
+ }
300
318
  /** The commands that read or write a ticket for a skill. Null when
301
319
  * `command` is not one of them. */
302
320
  async function ticketCommand(command, args, d) {
@@ -347,25 +365,26 @@ async function ticketCommand(command, args, d) {
347
365
  throw new Error(USAGE);
348
366
  if (!file && options(args, "--attach").length)
349
367
  throw new Error(USAGE);
350
- if (newTitle !== undefined) {
368
+ if (newTitle !== undefined)
351
369
  refuseBareTags(newTitle);
370
+ if (!file) {
352
371
  await t.writeTitle(ticket, newTitle);
353
- if (!file) {
354
- d.out("edited");
355
- return 0;
356
- }
372
+ d.out("edited");
373
+ return 0;
357
374
  }
358
- if (!file)
359
- throw new Error(USAGE);
360
375
  const attach = options(args, "--attach");
361
376
  const body = d.readFile(file);
362
377
  refuseBareTags(body);
363
378
  const files = attach.length ? need(t, "attachments") : null;
364
379
  if (command === "edit") {
380
+ // The body first: a body refused, as by a missing ticket field,
381
+ // leaves the title as it was.
365
382
  if (files)
366
383
  await files.writeBody(ticket, body, attach);
367
384
  else
368
385
  await t.writeBody(ticket, body);
386
+ if (newTitle !== undefined)
387
+ await t.writeTitle(ticket, newTitle);
369
388
  d.out("edited");
370
389
  }
371
390
  else
@@ -412,6 +431,11 @@ async function ticketCommand(command, args, d) {
412
431
  case "link":
413
432
  d.out(t.linkText(numbered()));
414
433
  return 0;
434
+ case "branch": {
435
+ const ticket = await t.read(numbered());
436
+ d.out(await branchOf(ticket.number, d));
437
+ return 0;
438
+ }
415
439
  case "blockers": {
416
440
  const list = await need(t, "blockers").list(numbered());
417
441
  for (const b of list)
@@ -436,7 +460,7 @@ async function ticketCommand(command, args, d) {
436
460
  return null;
437
461
  }
438
462
  }
439
- const USAGE = "Usage: npx --no-install factory ticket claim|still-live|stop|end|refining|waiting|refined|ready|cost|view|list|edit|comment|open|label|link|blockers|block|unblock|supports|follow-up ...";
463
+ const USAGE = "Usage: npx --no-install factory ticket claim|still-live|stop|end|refining|waiting|refined|ready|cost|view|list|edit|comment|open|label|link|branch|blockers|block|unblock|supports|follow-up ...";
440
464
  export async function main(argv, deps) {
441
465
  const [command, first, ...rest] = argv;
442
466
  const issue = Number(first);
@@ -449,6 +473,8 @@ export async function main(argv, deps) {
449
473
  ...deps,
450
474
  config: boardConfigOf(settings),
451
475
  codeHost: settings.codeHost.type,
476
+ // Null only when init reads the settings to ask for it.
477
+ branchName: settings.codeHost.branchName,
452
478
  repository,
453
479
  board,
454
480
  ...opened,
@@ -560,6 +586,7 @@ export async function run(argv) {
560
586
  return main(argv, {
561
587
  open: (settings, target) => openTickets(settings, target),
562
588
  openPulls: (repository, codeHost) => openCodeHost(repository, codeHost).open(),
589
+ signedInAs: (repository, codeHost) => openCodeHost(repository, codeHost).signedInAs(),
563
590
  runner: (repository, name) => openRunner(repository, name),
564
591
  settings: () => loadSettings(),
565
592
  env: process.env,
@@ -3,7 +3,7 @@
3
3
  import { boardConfigOf, inspectBoard } from "../board.mjs";
4
4
  import { fieldNamesOf } from "../config.mjs";
5
5
  import { listed } from "../lib/listed.mjs";
6
- const INIT = "Run npx --no-install factory init";
6
+ const INIT = "Run factory init";
7
7
  export const githubTicketsSetup = {
8
8
  checks: async (c) => {
9
9
  const s = c.settings;
@@ -209,6 +209,34 @@ export function commentIdFromUrl(url) {
209
209
  throw new Error(`gh printed no comment address: ${url.trim()}`);
210
210
  return Number(match[1]);
211
211
  }
212
+ const ISSUE_FIELDS = `query IssueFields($owner: String!, $name: String!) {
213
+ repository(owner: $owner, name: $name) {
214
+ issueFields(first: 100) {
215
+ nodes {
216
+ __typename
217
+ ... on IssueFieldText { id name description }
218
+ ... on IssueFieldSingleSelect { id name description }
219
+ ... on IssueFieldNumber { id name description }
220
+ ... on IssueFieldDate { id name description }
221
+ }
222
+ }
223
+ }
224
+ }`;
225
+ const FIELD_VALUES = `query IssueFieldValues($owner: String!, $name: String!, $number: Int!) {
226
+ repository(owner: $owner, name: $name) {
227
+ issue(number: $number) {
228
+ issueFieldValues(first: 50) {
229
+ nodes { ... on IssueFieldTextValue { value field { ... on IssueFieldText { name } } } }
230
+ }
231
+ }
232
+ }
233
+ }`;
234
+ const SET_ISSUE_FIELD = `mutation SetIssueField($issue: ID!, $field: ID!, $text: String!) {
235
+ setIssueFieldValue(input: { issueId: $issue, issueFields: [{ fieldId: $field, textValue: $text }] }) { clientMutationId }
236
+ }`;
237
+ const CLEAR_ISSUE_FIELD = `mutation ClearIssueField($issue: ID!, $field: ID!) {
238
+ setIssueFieldValue(input: { issueId: $issue, issueFields: [{ fieldId: $field, delete: true }] }) { clientMutationId }
239
+ }`;
212
240
  export function githubTickets(o) {
213
241
  const API = `repos/${o.repository}`;
214
242
  const [repoOwner, repoName] = o.repository.split("/");
@@ -220,6 +248,11 @@ export function githubTickets(o) {
220
248
  const answer = await t.graphql(STATUS_FIELD, { owner: o.boardOwner ?? repoOwner, number });
221
249
  return answer.data.owner?.projectV2?.field ?? null;
222
250
  };
251
+ /** The repository's issue fields, each with its type. */
252
+ const issueFields = async () => {
253
+ const answer = await t.graphql(ISSUE_FIELDS, { owner: repoOwner, name: repoName });
254
+ return answer.data.repository.issueFields.nodes.filter((f) => f !== null);
255
+ };
223
256
  const readBoard = async () => {
224
257
  if (o.board === null)
225
258
  return { projectId: "", fields: [], items: new Map() };
@@ -403,6 +436,42 @@ export function githubTickets(o) {
403
436
  return missing.map((f) => f.name);
404
437
  },
405
438
  },
439
+ fields: {
440
+ plainText: true,
441
+ async list() {
442
+ return (await issueFields()).map((f) => ({
443
+ name: f.name,
444
+ description: f.description ?? null,
445
+ text: f.__typename === "IssueFieldText",
446
+ }));
447
+ },
448
+ async holds() {
449
+ return { max: null };
450
+ },
451
+ async read(n) {
452
+ const answer = await t.graphql(FIELD_VALUES, { owner: repoOwner, name: repoName, number: n });
453
+ const found = answer.data.repository.issue;
454
+ if (!found)
455
+ throw new NotFoundError(`#${n}`);
456
+ const values = {};
457
+ for (const v of found.issueFieldValues.nodes)
458
+ if (v?.field?.name)
459
+ values[v.field.name] = v.value ?? "";
460
+ return values;
461
+ },
462
+ async write(n, values) {
463
+ const fields = await issueFields();
464
+ const { node_id } = await issue(n);
465
+ for (const [name, value] of Object.entries(values)) {
466
+ const field = fields.find((f) => f.name === name);
467
+ if (!field)
468
+ throw new Error(`No issue field called ${name}.`);
469
+ await t.graphql(value === null ? CLEAR_ISSUE_FIELD : SET_ISSUE_FIELD, value === null
470
+ ? { issue: node_id, field: field.id }
471
+ : { issue: node_id, field: field.id, text: value });
472
+ }
473
+ },
474
+ },
406
475
  blockers: {
407
476
  async list(n) {
408
477
  const list = await found(`#${n}`, t.rest("GET", `${API}/issues/${n}/dependencies/blocked_by`, { paginate: true }));
@@ -1,6 +1,7 @@
1
1
  import { type Gh } from "../lib/gh.mts";
2
2
  import { type Settings } from "../config.mts";
3
- import type { Tickets } from "./types.mts";
3
+ import { type Tickets } from "./types.mts";
4
+ import { type FieldMapping } from "../ticket-fields.mts";
4
5
  export * from "./types.mts";
5
6
  /** The ticket system's message for a type that is not built. */
6
7
  export declare const unsupportedType: (type: string) => string;
@@ -13,3 +14,9 @@ export declare function openTickets(settings: Settings, target: {
13
14
  repository: string;
14
15
  board: number | null;
15
16
  }, run?: Gh): Promise<Opened>;
17
+ /** The adapter with each ticket read as one document and written back
18
+ * split: the description, and each ticket field `tickets.fields` names.
19
+ * The follow-ups ticket stays whole. `readAll` is the adapter's, since its
20
+ * callers read comments, labels, and cards, never a refined ticket's
21
+ * sections. */
22
+ export declare function withTicketFields(inner: Tickets, mapping: FieldMapping, repository: string): Tickets;
@@ -5,6 +5,8 @@ import { gh } from "../lib/gh.mjs";
5
5
  import { fieldNamesOf } from "../config.mjs";
6
6
  import { githubTickets } from "./github.mjs";
7
7
  import { ghTransport } from "./transport.mjs";
8
+ import { need } from "./types.mjs";
9
+ import { join, split } from "../ticket-fields.mjs";
8
10
  import { BUILT, unsupported } from "../tool-names.mjs";
9
11
  export * from "./types.mjs";
10
12
  /** The ticket system's message for a type that is not built. */
@@ -16,13 +18,71 @@ export async function openTickets(settings, target, run = gh) {
16
18
  if (type !== "github")
17
19
  throw new Error(unsupportedType(type));
18
20
  const transport = ghTransport(run);
21
+ const tickets = githubTickets({
22
+ transport,
23
+ repository: target.repository,
24
+ board: target.board,
25
+ cli: run,
26
+ fieldNames: fieldNamesOf(settings),
27
+ });
28
+ const mapping = settings.tickets.ticketFields;
19
29
  return {
20
- tickets: githubTickets({
21
- transport,
22
- repository: target.repository,
23
- board: target.board,
24
- cli: run,
25
- fieldNames: fieldNamesOf(settings),
26
- }),
30
+ tickets: Object.values(mapping).some((v) => v !== null)
31
+ ? withTicketFields(tickets, mapping, target.repository)
32
+ : tickets,
27
33
  };
28
34
  }
35
+ /** The adapter with each ticket read as one document and written back
36
+ * split: the description, and each ticket field `tickets.fields` names.
37
+ * The follow-ups ticket stays whole. `readAll` is the adapter's, since its
38
+ * callers read comments, labels, and cards, never a refined ticket's
39
+ * sections. */
40
+ export function withTicketFields(inner, mapping, repository) {
41
+ const fields = () => need(inner, "fields");
42
+ const whole = (labels) => labels.includes("follow-up");
43
+ /** The description to write, once every named field is checked and
44
+ * written. */
45
+ const written = async (n, body) => {
46
+ const { labels } = await inner.read(n);
47
+ if (whole(labels))
48
+ return body;
49
+ const ops = fields();
50
+ const known = await ops.list();
51
+ for (const [key, name] of Object.entries(mapping)) {
52
+ if (name === null)
53
+ continue;
54
+ const field = known.find((f) => f.name === name);
55
+ if (!field)
56
+ throw new Error(`${repository}'s tickets have no field called ${name}, which tickets.fields.${key} names.`);
57
+ if (!field.text)
58
+ throw new Error(`${name}, which tickets.fields.${key} names, doesn't hold text.`);
59
+ }
60
+ const parts = split(body, mapping);
61
+ if ("error" in parts)
62
+ throw new Error(parts.error);
63
+ await ops.write(n, parts.values);
64
+ return parts.description;
65
+ };
66
+ const tickets = {
67
+ ...inner,
68
+ async read(n) {
69
+ const ticket = await inner.read(n);
70
+ if (whole(ticket.labels))
71
+ return ticket;
72
+ const values = await fields().read(n);
73
+ return {
74
+ ...ticket,
75
+ body: join(ticket.body, values, mapping, ticket.labels),
76
+ };
77
+ },
78
+ async writeBody(n, body) {
79
+ await inner.writeBody(n, await written(n, body));
80
+ },
81
+ };
82
+ if (inner.attachments)
83
+ tickets.attachments = {
84
+ ...inner.attachments,
85
+ writeBody: async (n, body, files) => inner.attachments.writeBody(n, await written(n, body), files),
86
+ };
87
+ return tickets;
88
+ }
@@ -123,7 +123,31 @@ export type AttachmentOps = {
123
123
  /** Replaces the body with the images attached. */
124
124
  writeBody(ticket: number, body: string, files: string[]): Promise<void>;
125
125
  };
126
- export declare const GROUPS: readonly ["board", "blockers", "label-history", "attachments"];
126
+ /** A field tickets can have, set on the ticket itself. */
127
+ export type TicketField = {
128
+ name: string;
129
+ /** The field's own description, for the coding agent; null with none. */
130
+ description: string | null;
131
+ /** Whether it holds text, so it can hold a factory field. */
132
+ text: boolean;
133
+ };
134
+ export type FieldOps = {
135
+ /** Whether a field shows its text as typed, without formatting. */
136
+ plainText: boolean;
137
+ /** The fields tickets can have, in the system's order. */
138
+ list(): Promise<TicketField[]>;
139
+ /** Whether the ticket can hold the field, and how many characters. */
140
+ holds(ticket: number, field: string): Promise<{
141
+ max: number | null;
142
+ } | {
143
+ reason: string;
144
+ }>;
145
+ /** The ticket's text field values, by field name. */
146
+ read(ticket: number): Promise<Record<string, string>>;
147
+ /** Sets each field by name; null clears it. */
148
+ write(ticket: number, values: Record<string, string | null>): Promise<void>;
149
+ };
150
+ export declare const GROUPS: readonly ["board", "blockers", "label-history", "attachments", "fields"];
127
151
  export type Group = (typeof GROUPS)[number];
128
152
  export type NewTicket = {
129
153
  title: string;
@@ -162,6 +186,7 @@ export type Tickets = {
162
186
  blockers?: BlockerOps;
163
187
  labelHistory?: LabelHistoryOps;
164
188
  attachments?: AttachmentOps;
189
+ fields?: FieldOps;
165
190
  };
166
191
  /** A ticket or comment that does not exist, told apart from any other
167
192
  * failure. Every adapter throws this one. */
@@ -181,6 +206,7 @@ declare const GROUP_KEYS: {
181
206
  readonly blockers: "blockers";
182
207
  readonly "label-history": "labelHistory";
183
208
  readonly attachments: "attachments";
209
+ readonly fields: "fields";
184
210
  };
185
211
  type GroupKey<G extends Group> = (typeof GROUP_KEYS)[G];
186
212
  /** "Read everything at once" from the list and the single reads, for an
@@ -8,6 +8,7 @@ export const GROUPS = [
8
8
  "blockers",
9
9
  "label-history",
10
10
  "attachments",
11
+ "fields",
11
12
  ];
12
13
  /** A ticket or comment that does not exist, told apart from any other
13
14
  * failure. Every adapter throws this one. */
@@ -35,6 +36,8 @@ export function supports(tickets, group) {
35
36
  return tickets.labelHistory !== undefined;
36
37
  case "attachments":
37
38
  return tickets.attachments !== undefined;
39
+ case "fields":
40
+ return tickets.fields !== undefined;
38
41
  }
39
42
  }
40
43
  /** The group's operations, or UnsupportedError naming it. */
@@ -50,6 +53,7 @@ const GROUP_KEYS = {
50
53
  blockers: "blockers",
51
54
  "label-history": "labelHistory",
52
55
  attachments: "attachments",
56
+ fields: "fields",
53
57
  };
54
58
  /** "Read everything at once" from the list and the single reads, for an
55
59
  * adapter that does not override it. It returns the open tickets: a list of
package/dist/tools.d.mts CHANGED
@@ -49,7 +49,7 @@ export declare function secretSteps(r: Registry, c: SetupContext): {
49
49
  }[];
50
50
  /** The same context for other parts. */
51
51
  export declare const withParts: (c: SetupContext, parts: Iterable<Part>) => {
52
- parts: Set<"board" | "review" | "cloud" | "auto-merge" | "from-board" | "signing">;
52
+ parts: Set<"board" | "review" | "cloud" | "from-board" | "auto-merge" | "signing">;
53
53
  repository: string;
54
54
  root: string;
55
55
  chosen: Chosen;
package/docs/builds.md CHANGED
@@ -116,28 +116,40 @@ does no further check.
116
116
  ### What it reads from its environment
117
117
 
118
118
  On a server you host, the poller runs with no copy of your repository, so
119
- it takes everything from environment variables. All four are required; it
120
- exits at startup naming any that is missing. On a schedule it has a
119
+ it takes everything from environment variables. All five are required.
120
+ Without `FACTORY_REPOSITORY` it doesn't start. Without any of the others,
121
+ it logs `not polling:` naming each that is missing, and starts no build
122
+ until they are set. On a schedule it has a
121
123
  checkout, and needs only the token.
122
124
 
123
125
  | Variable | What it is |
124
126
  | ---------------------- | ------------------------------------------------------------------- |
125
127
  | `FACTORY_REPOSITORY` | The repository, as `owner/name` |
126
128
  | `FACTORY_BOARD_OWNER` | The account the board belongs to |
127
- | `FACTORY_BOARD_NUMBER` | Which board |
129
+ | `FACTORY_BOARD_NUMBER` | The board's number, the last part of its address |
128
130
  | `FACTORY_BOARD_TOKEN` | An access token that can read the board, comment, and start a build |
131
+ | `FACTORY_READY_COLUMN` | The column that approves a build |
129
132
 
130
- One more is optional. `FACTORY_READY_COLUMN` is the name of the column
131
- that approves a build, and defaults to Ready. The poller has no settings
132
- file, so a repository whose
133
- [`tickets.columns.ready`](configuration.md#ticketscolumns) names another
134
- column sets it where the poller runs. `factory board check` reminds you
135
- when it applies.
133
+ The repository, the board's number, and the ready column repeat what your
134
+ settings file says, because the poller cannot read it. The ready column
135
+ is the one [`tickets.columns.ready`](configuration.md#ticketscolumns)
136
+ names. [`factory board check`](cli.md) prints it on the ready row, for
137
+ you to copy:
136
138
 
137
- The repository and the board's number repeat what your settings file says,
138
- because the poller cannot read it. The factory takes the board's owner to
139
- be the repository's owner everywhere else, a person or an organization, so
140
- a board owned by another account is not supported yet.
139
+ ```text
140
+ ? ready Ready: the poller needs FACTORY_READY_COLUMN set to "Ready"
141
+ ```
142
+
143
+ A poller only runs with a ready column: with `ready: none`, builds start
144
+ only when you ask, and there is no poller to host.
145
+
146
+ A poller set up before `FACTORY_READY_COLUMN` was required logs
147
+ `not polling: FACTORY_READY_COLUMN not set` after an update, and polls
148
+ nothing until you set it.
149
+
150
+ The factory takes the board's owner to be the repository's owner
151
+ everywhere else, a person or an organization, so a board owned by another
152
+ account is not supported yet.
141
153
 
142
154
  ### Its limits
143
155
 
@@ -171,6 +183,7 @@ docker run \
171
183
  -e FACTORY_BOARD_OWNER=your-name \
172
184
  -e FACTORY_BOARD_NUMBER=1 \
173
185
  -e FACTORY_BOARD_TOKEN \
186
+ -e FACTORY_READY_COLUMN=Ready \
174
187
  ghcr.io/davidbyoung/software-factory-poller:0.2.0
175
188
  ```
176
189