@plainconceptsplatform/workflows 1.10.0 → 1.10.1

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.
@@ -29,6 +29,12 @@ inputs:
29
29
  occurrence is a blip; an issue that is already open is always appended to.
30
30
  required: false
31
31
  default: '2'
32
+ min-occurrences-unknown:
33
+ description: >-
34
+ The same, for a failure the catalogue could not classify. With no diagnosis behind it, a
35
+ cause has to repeat more before it is worth a person's time.
36
+ required: false
37
+ default: '3'
32
38
  max-findings:
33
39
  description: The most issues one run opens, the most frequent first. The rest stay in the job summary.
34
40
  required: false
@@ -58,6 +64,7 @@ runs:
58
64
  UPSTREAM_REPO: ${{ inputs.upstream-repo }}
59
65
  LOOKBACK_HOURS: ${{ inputs.lookback-hours }}
60
66
  MIN_OCCURRENCES: ${{ inputs.min-occurrences }}
67
+ MIN_UNKNOWN: ${{ inputs.min-occurrences-unknown }}
61
68
  MAX_FINDINGS: ${{ inputs.max-findings }}
62
69
  QUIET_DAYS: ${{ inputs.quiet-days }}
63
70
  POLICY_PATH: ${{ github.action_path }}/report-policy.cjs
@@ -118,7 +125,7 @@ runs:
118
125
  // line carries repository paths, branch names and issue titles.
119
126
  const CATALOGUE = [
120
127
  { id: 'runner-never-assigned', test: /waiting for a runner|no runner matching|requested labels/i, note: 'A job waited for a self-hosted runner that never arrived.' },
121
- { id: 'runner-lost-mid-job', test: /lost communication with the server|runner has received a shutdown signal|The self-hosted runner:.*lost/i, note: 'The runner disappeared while a job was running.' },
128
+ { id: 'runner-lost-mid-job', test: /lost communication with the server|runner has received a shutdown signal|The self-hosted runner:.*lost|exit code 143/i, note: 'The runner disappeared while a job was running.' },
122
129
  { id: 'job-cancelled-by-timeout', test: /The job running on runner .* has exceeded the maximum execution time|timeout-minutes/i, note: 'A job hit its timeout instead of finishing.' },
123
130
  { id: 'out-of-disk', test: /no space left on device|You are running out of disk space/i, note: 'The runner ran out of disk.' },
124
131
  { id: 'out-of-memory', test: /JavaScript heap out of memory|Killed\s+process|OOMKilled/i, note: 'A step was killed for memory.' },
@@ -187,7 +194,7 @@ runs:
187
194
  // Things that happened and are worth a number in the job summary, but that nobody can
188
195
  // fix by editing a workflow, so they never open an issue: a cancelled job with no step
189
196
  // that failed, a log that could not be read, and the fleet's own transient causes.
190
- const quiet = { cancelledNoStep: 0, unreadable: 0, infra: new Map() };
197
+ const quiet = { cancelledNoStep: 0, unreadable: 0, retried: 0, reviewChecks: 0, infra: new Map() };
191
198
  let queueWaitTotal = 0;
192
199
  let queueWaitCount = 0;
193
200
  let queueWaitWorst = 0;
@@ -213,6 +220,9 @@ runs:
213
220
  if (!['failure', 'cancelled', 'timed_out', 'startup_failure'].includes(run.conclusion)) continue;
214
221
  ownedFailures += 1;
215
222
 
223
+ // A lint check failing on a pull request has done its job on somebody's change.
224
+ if (policy.isReviewCheck({ workflow: file, event: run.event })) { quiet.reviewChecks += 1; continue; }
225
+
216
226
  let jobs = [];
217
227
  try {
218
228
  jobs = await github.paginate(github.rest.actions.listJobsForWorkflowRunAttempt, {
@@ -220,6 +230,10 @@ runs:
220
230
  });
221
231
  } catch { continue; }
222
232
 
233
+ // The worker already caught this one and sent the work back through the router; the
234
+ // attempt that parks does not retry, so a failure no retry got past is still read.
235
+ if (policy.wasRetried(jobs)) { quiet.retried += 1; continue; }
236
+
223
237
  for (const job of jobs) {
224
238
  if (job.started_at && job.created_at) {
225
239
  const wait = (new Date(job.started_at) - new Date(job.created_at)) / 1000;
@@ -251,20 +265,24 @@ runs:
251
265
  annotationText = notes.map((note) => note.message ?? '').join('\n');
252
266
  } catch { /* annotations are an extra; the log can still classify */ }
253
267
 
254
- let patternId = 'unrecognised';
268
+ // A step whose name already says what failed is not read further: a missing secret
269
+ // is the repository's to set, whatever the log says around it.
270
+ let patternId = policy.causeFromStep(step?.name) ?? 'unrecognised';
255
271
  let logRead = true;
256
- try {
257
- const { data: log } = await github.rest.actions.downloadJobLogsForWorkflowRun({
258
- ...context.repo, job_id: job.id,
259
- });
260
- const text = typeof log === 'string' ? log : Buffer.from(log).toString('utf8');
261
- // The tail is where the failure is, and reading less of the log is less to get
262
- // wrong. Only the matched entry's id crosses into the report.
263
- const tail = `${annotationText}\n${text.slice(-20000)}`;
264
- patternId = CATALOGUE.find((entry) => entry.test.test(tail))?.id ?? 'unrecognised';
265
- } catch {
266
- logRead = false;
267
- patternId = CATALOGUE.find((entry) => entry.test.test(annotationText))?.id ?? 'log-unavailable';
272
+ if (patternId === 'unrecognised') {
273
+ try {
274
+ const { data: log } = await github.rest.actions.downloadJobLogsForWorkflowRun({
275
+ ...context.repo, job_id: job.id,
276
+ });
277
+ const text = typeof log === 'string' ? log : Buffer.from(log).toString('utf8');
278
+ // The tail is where the failure is, and reading less of the log is less to get
279
+ // wrong. Only the matched entry's id crosses into the report.
280
+ const tail = `${annotationText}\n${text.slice(-20000)}`;
281
+ patternId = CATALOGUE.find((entry) => entry.test.test(tail))?.id ?? 'unrecognised';
282
+ } catch {
283
+ logRead = false;
284
+ patternId = CATALOGUE.find((entry) => entry.test.test(annotationText))?.id ?? 'log-unavailable';
285
+ }
268
286
  }
269
287
 
270
288
  // A log nobody could read says nothing, so it is counted and not filed.
@@ -303,7 +321,8 @@ runs:
303
321
  }
304
322
 
305
323
  const catalogueNote = (id) => CATALOGUE.find((entry) => entry.id === id)?.note
306
- ?? (id === 'log-unavailable' ? 'The job log could not be read, so the failure could not be classified.'
324
+ ?? (id === 'missing-secret' ? 'A workflow stopped at a check for a secret this repository has not set.'
325
+ : id === 'log-unavailable' ? 'The job log could not be read, so the failure could not be classified.'
307
326
  : 'The log matched no known failure shape. Worth adding one to the catalogue.');
308
327
 
309
328
  const ranked = [...findings.values()].sort((a, b) => b.count - a.count);
@@ -313,6 +332,7 @@ runs:
313
332
  // person's time, and a bad night opens a handful of issues rather than forty.
314
333
  const selection = policy.select(ranked, {
315
334
  minOccurrences: Number(process.env.MIN_OCCURRENCES),
335
+ minUnknown: Number(process.env.MIN_UNKNOWN),
316
336
  maxFindings: Number(process.env.MAX_FINDINGS),
317
337
  });
318
338
 
@@ -385,6 +405,8 @@ runs:
385
405
  `Distinct failure signatures: ${ranked.length}`,
386
406
  `Filed or appended: ${selection.file.length}; held back: ${selection.held.length}`,
387
407
  `Cancelled jobs with no failing step, not reported: ${quiet.cancelledNoStep}`,
408
+ `Runs whose failure the worker retried through the router, not reported: ${quiet.retried}`,
409
+ `Checks that failed on a pull request, not reported: ${quiet.reviewChecks}`,
388
410
  `Jobs whose log could not be read, not reported: ${quiet.unreadable}`,
389
411
  `Infrastructure causes, counted and not reported: ${[...quiet.infra].map(([id, n]) => `${id} ${n}`).join(', ') || 'none'}`,
390
412
  queueWaitCount > 0
@@ -397,6 +419,12 @@ runs:
397
419
  ])
398
420
  .write();
399
421
 
422
+ // The repository's own configuration is said here, to the people who can change it, and
423
+ // nowhere else. The step name is the package's (or gh-aw's) own words.
424
+ for (const { finding } of selection.held.filter(({ finding }) => finding.severity === 'consumer')) {
425
+ core.warning(`${finding.count} job(s) of ${finding.workflow} stopped at "${finding.step}": set the secret it checks for, or the work it guards never runs.`);
426
+ }
427
+
400
428
  if (ranked.length === 0) {
401
429
  core.info('No failures in the window for any workflow this package ships.');
402
430
  core.setOutput('filed', '');
@@ -427,6 +455,18 @@ runs:
427
455
  const upstream = getOctokit(upstreamToken);
428
456
  const filed = [];
429
457
 
458
+ // The latest release, to tell a failure a release may already have fixed from one that
459
+ // is still live. Best effort: a token that cannot read tags files as before.
460
+ let latestRelease = '';
461
+ try {
462
+ const { data: tags } = await upstream.rest.repos.listTags({
463
+ owner: upstreamOwner, repo: upstreamName, per_page: 100,
464
+ });
465
+ latestRelease = policy.latestVersion(tags.map((tag) => tag.name));
466
+ } catch (error) {
467
+ core.info(`could not read the upstream tags: HTTP ${error.status ?? '?'}`);
468
+ }
469
+
430
470
  for (const { finding, title, body } of reports) {
431
471
  const marker = body.split('\n')[0];
432
472
  // One issue per signature, updated rather than repeated. Searching by the marker
@@ -450,6 +490,13 @@ runs:
450
490
  core.warning(`could not search upstream for an existing report: HTTP ${error.status ?? '?'}`);
451
491
  }
452
492
 
493
+ // An install a minor or more behind does not open a new issue: update it first. It
494
+ // still appends to one that is open, because then the bug is live on newer versions too.
495
+ if (!existing && policy.isOutdated(packageVersion, latestRelease)) {
496
+ core.info(`left alone, ${packageVersion} is behind ${latestRelease}; update first: ${title}`);
497
+ continue;
498
+ }
499
+
453
500
  if (dryRun) {
454
501
  core.info(`[dry-run] would ${existing ? `append to #${existing.number}` : 'open an issue'}: ${title}`);
455
502
  continue;
@@ -10,6 +10,11 @@
10
10
  // a runner shut down under a job, 47% re-filed a signature seen before, every one was closed as
11
11
  // not planned and none had a comment. What follows is the filter that would have kept about a
12
12
  // hundred of them out of that pile and left the rest as a count in the job summary.
13
+ //
14
+ // The 11 that still got through in the week to 2026-11-03 were the next layer: 39 jobs a day failing
15
+ // gh-aw's check for an engine secret the repository never set, agent failures the worker had
16
+ // already sent back through the router and recovered, a shellcheck step failing on a pull request
17
+ // it was right to fail, and installs several minors behind reporting what a release had fixed.
13
18
 
14
19
  'use strict';
15
20
 
@@ -27,6 +32,13 @@ const INFRA = new Set([
27
32
  'out-of-memory',
28
33
  ]);
29
34
 
35
+ // Causes that belong to the repository that installed the package: a secret it never set. They are
36
+ // warned about in that repository's own job summary, where the person who can set it will look,
37
+ // and never filed upstream, where nobody can.
38
+ const CONSUMER = new Set([
39
+ 'missing-secret',
40
+ ]);
41
+
30
42
  // Causes that are a defect in something this package ships.
31
43
  const PACKAGE_BUG = new Set([
32
44
  'jq-error',
@@ -39,13 +51,75 @@ const PACKAGE_BUG = new Set([
39
51
  'gh-api-409-conflict',
40
52
  ]);
41
53
 
42
- /** infra, package-bug, or unknown (a cause nobody classified yet, worth a look when it repeats). */
54
+ /** infra, consumer, package-bug, or unknown (a cause nobody classified yet, worth a look when it repeats). */
43
55
  function severityOf(patternId) {
44
56
  if (INFRA.has(patternId)) return 'infra';
57
+ if (CONSUMER.has(patternId)) return 'consumer';
45
58
  if (PACKAGE_BUG.has(patternId)) return 'package-bug';
46
59
  return 'unknown';
47
60
  }
48
61
 
62
+ /**
63
+ * Some steps say what failed by their name alone, and their log says it in words the catalogue
64
+ * cannot safely match: gh-aw's secret check names the variable, and a pattern for that name would
65
+ * put an engine name in a file that asserts it never reaches for a model. Step names are the
66
+ * package's own (or gh-aw's, compiled into the package's lock files), so they are safe to read.
67
+ */
68
+ function causeFromStep(step) {
69
+ if (/^Validate .* secrets?$/i.test(step ?? '')) return 'missing-secret';
70
+ if (/^Check workflow lock file$/i.test(step ?? '')) return 'lock-out-of-date';
71
+ return null;
72
+ }
73
+
74
+ /**
75
+ * A worker that hits a short run, a runner shutdown or a cut-off sends the work back through the
76
+ * router (decide-agent-retry) and the next attempt usually lands. The failed agent job stays red in
77
+ * the run that retried it, and used to be filed as if nothing had caught it. A run whose retry step
78
+ * succeeded has had its failure answered; the attempt that finally parks does not retry, so a
79
+ * failure the retries never got past is still counted.
80
+ */
81
+ function wasRetried(jobs) {
82
+ return (jobs ?? []).some((job) => (job.steps ?? []).some((step) =>
83
+ /^Send the (work|issue) back through the router$/.test(step.name ?? '') && step.conclusion === 'success'));
84
+ }
85
+
86
+ /**
87
+ * agentics-checks lints the repository's workflows and actions. On a pull request a red check is
88
+ * the check doing its job on somebody's change; only on the default branch, where the package's
89
+ * own files are what is there, can its failure be the package's.
90
+ */
91
+ function isReviewCheck({ workflow, event }) {
92
+ return workflow === 'agentics-checks.yml' && (event === 'pull_request' || event === 'pull_request_target');
93
+ }
94
+
95
+ /**
96
+ * Whether the reporting install is a minor or more behind the latest release. Its failure may be
97
+ * one the release already fixed, so it does not open an issue; it still appends to one that is
98
+ * open. Patch versions are left alone: the fleet is rolled out the same day and a patch behind is
99
+ * the normal state for hours after every release.
100
+ */
101
+ function isOutdated(reporting, latest) {
102
+ const parse = (v) => /^v?(\d+)\.(\d+)\./.exec(v ?? '')?.slice(1, 3).map(Number);
103
+ const a = parse(reporting);
104
+ const b = parse(latest);
105
+ if (!a || !b) return false;
106
+ return a[0] < b[0] || (a[0] === b[0] && a[1] < b[1]);
107
+ }
108
+
109
+ /**
110
+ * The newest release among the upstream tags. Tags, not GitHub releases or the npm dist-tag: the
111
+ * fleet is rolled out from tags, and both of the others have lagged them by several minors.
112
+ */
113
+ function latestVersion(tags) {
114
+ let best = '';
115
+ for (const tag of tags ?? []) {
116
+ if (!/^v?\d+\.\d+\.\d+$/.test(tag)) continue;
117
+ const [a, b] = [tag, best].map((v) => v.replace(/^v/, '').split('.').map(Number));
118
+ if (!best || a[0] > b[0] || (a[0] === b[0] && (a[1] > b[1] || (a[1] === b[1] && a[2] > b[2])))) best = tag;
119
+ }
120
+ return best;
121
+ }
122
+
49
123
  /**
50
124
  * One cause is one issue. A specific cause is the same defect whichever job of the router tripped
51
125
  * on it, so the job and the step are not part of its identity: conclude, safe_outputs and reserve
@@ -65,19 +139,26 @@ function markerKey({ workflow, step, conclusion, patternId }) {
65
139
  /**
66
140
  * Which findings become issues, and why the others do not.
67
141
  * - infra causes are held: they are a rate, not a bug.
142
+ * - consumer causes are held: the repository that has them is the one that can fix them.
68
143
  * - a finding seen fewer than `minOccurrences` times in the window is held: once is a blip.
144
+ * - an unrecognised cause needs `minUnknown`: with no diagnosis, twice in a day was mostly a
145
+ * provider hiccup nobody could act on.
69
146
  * - at most `maxFindings` are filed per run, the most frequent first, so a bad night opens a
70
147
  * handful of issues and not forty.
71
148
  */
72
- function select(findings, { minOccurrences = 2, maxFindings = 5 } = {}) {
149
+ function select(findings, { minOccurrences = 2, minUnknown = 3, maxFindings = 5 } = {}) {
73
150
  const ranked = [...findings].sort((a, b) => b.count - a.count);
74
151
  const file = [];
75
152
  const held = [];
153
+ const neededFor = (finding) => (finding.severity === 'unknown' ? Math.max(minOccurrences, minUnknown) : minOccurrences);
76
154
  for (const finding of ranked) {
77
155
  if (finding.severity === 'infra') {
78
156
  held.push({ finding, reason: 'infrastructure cause, counted not filed' });
79
- } else if (finding.count < minOccurrences) {
80
- held.push({ finding, reason: `seen ${finding.count} time(s), under the ${minOccurrences} needed to file` });
157
+ } else if (finding.severity === 'consumer') {
158
+ held.push({ finding, reason: "this repository's own configuration, warned here not filed" });
159
+ } else if (finding.count < neededFor(finding)) {
160
+ const needed = neededFor(finding);
161
+ held.push({ finding, reason: `seen ${finding.count} time(s), under the ${needed} needed to file` });
81
162
  } else if (file.length >= maxFindings) {
82
163
  held.push({ finding, reason: `over the ${maxFindings} filed per run` });
83
164
  } else {
@@ -107,4 +188,7 @@ function parseVersion(header) {
107
188
  return match ? match[1] : 'unknown';
108
189
  }
109
190
 
110
- module.exports = { INFRA, PACKAGE_BUG, severityOf, signatureOf, markerKey, select, isQuiet, parseVersion };
191
+ module.exports = {
192
+ INFRA, CONSUMER, PACKAGE_BUG, severityOf, causeFromStep, wasRetried, isReviewCheck, isOutdated, latestVersion,
193
+ signatureOf, markerKey, select, isQuiet, parseVersion,
194
+ };
@@ -2414,6 +2414,21 @@ if [ -f "$ERROR_REPORT_YML" ]; then
2414
2414
  ok(p.isQuiet(null, now, 30) === false, "no closing date is not quiet");
2415
2415
  ok(p.parseVersion("# Managed by @plainconceptsplatform/workflows@1.2.3. Source: x") === "1.2.3", "the version has no trailing full stop");
2416
2416
  ok(p.parseVersion("nothing here") === "unknown", "no version reads as unknown");
2417
+ // The layer that still got through: a secret the consumer never set, an agent failure the
2418
+ // worker had already retried, a lint check failing on a pull request, an outdated install.
2419
+ ok(p.severityOf("missing-secret") === "consumer", "a missing secret belongs to the consumer");
2420
+ ok(p.causeFromStep("Validate CODEX_API_KEY or OPENAI_API_KEY secret") === "missing-secret", "the secret check is read from its step name");
2421
+ ok(p.causeFromStep("Execute OpenCode CLI") === null, "any other step is left to the catalogue");
2422
+ const held = p.select([f("s", 39, "consumer"), f("u", 2, "unknown"), f("k", 2, "package-bug")], { minOccurrences: 2, minUnknown: 3, maxFindings: 5 });
2423
+ ok(held.file.map((x) => x.patternId).join() === "k", "a consumer cause and an undiagnosed pair are held, a diagnosed pair is filed");
2424
+ const retry = (conclusion) => [{ steps: [{ name: "Execute OpenCode CLI", conclusion: "failure" }] }, { steps: [{ name: "Send the work back through the router", conclusion }] }];
2425
+ ok(p.wasRetried(retry("success")) === true, "a run whose retry was sent is answered");
2426
+ ok(p.wasRetried(retry("skipped")) === false, "a run that parked is not");
2427
+ ok(p.isReviewCheck({ workflow: "agentics-checks.yml", event: "pull_request" }) === true, "a check failing on a pull request did its job");
2428
+ ok(p.isReviewCheck({ workflow: "agentics-checks.yml", event: "push" }) === false, "a check failing on the default branch is read");
2429
+ ok(p.isOutdated("1.6.41", "v1.10.0") === true && p.isOutdated("1.10.0", "v1.10.1") === false, "only a minor or more behind is outdated");
2430
+ ok(p.isOutdated("unknown", "v1.10.0") === false && p.isOutdated("1.9.0", "") === false, "an unknown version files as before");
2431
+ ok(p.latestVersion(["v1.9.4", "v1.10.0", "v0.28.11-alpha.1", "v1.8.3"]) === "v1.10.0", "the newest tag is read numerically, prereleases left out");
2417
2432
  if (bad.length) { console.error(bad.join("\n")); process.exit(1); }
2418
2433
  '
2419
2434
  if node -e "$policy_js" "$POLICY_CJS" 2>/tmp/policy-err; then
@@ -2432,6 +2447,9 @@ if [ -f "$ERROR_REPORT_YML" ]; then
2432
2447
  er "patternId === 'log-unavailable'\) \{ quiet\.unreadable \+= 1; continue; \}" 'files jobs whose log could not be read'
2433
2448
  er 'policy\.isQuiet\(' 'does not keep a recently closed signature quiet'
2434
2449
  er 'listAnnotations' 'does not read the job annotations, where the runner shutdown is written'
2450
+ er 'if \(policy\.wasRetried\(jobs\)\) \{ quiet\.retried \+= 1; continue; \}' 'files agent failures the worker already retried'
2451
+ er 'if \(policy\.isReviewCheck\(.*\{ quiet\.reviewChecks \+= 1; continue; \}' 'files lint checks that failed on a pull request'
2452
+ er 'if \(!existing && policy\.isOutdated\(' 'opens issues from installs a minor or more behind'
2435
2453
 
2436
2454
  # 4. No model. A model asked to summarise a failure paraphrases whatever the log held, which
2437
2455
  # is the one thing that must not cross the boundary. This job stays deterministic.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@plainconceptsplatform/workflows",
3
- "version": "1.10.0",
3
+ "version": "1.10.1",
4
4
  "description": "Install and update Platform GitHub agentic workflows.",
5
5
  "keywords": [
6
6
  "github-actions",