docs(ci): document main-health.yml, the workflow the CI page never listed #2345

Merged
jaylouisw merged 1 commit from docs/1121-0117 into main 2026-11-21 01:38:38 +00:00
Owner

docs/CI.md says it is written from the workflows in .forgejo/workflows/ — "if the two disagree the workflow is right and this page is a bug". main-health.yml landed there on 2026-11-20 (#2326) and the page never mentioned it.

Three statements were untrue as a result:

  • The trigger table ended at wiki-sync.yml, so the job that turns a red main into an issue was undocumented; a reader of the page could not know it exists, what it opens, or that it writes issues at all.
  • The badge advice enumerates what .forgejo/workflows/ holds — six files named, seven present.
  • "Three workflows need to write" had become four.

The new row is written from the file: a 15-minute schedule plus a manual dispatch taking sha (default the head of main) and dry_run (default true); it reads the head's status set and opens one issue titled main is red, naming every failing check with the run link its status carries, reporting a given head once (the head is written into the issue body) and commenting and closing on the first green tick. It merges, rebases and arms nothing, and a tick that cannot read the status set warns instead of reporting main as fine.

The token paragraph now separates the workflows that must push (which is why the secret exists) from main-health.yml, which only writes issues — permissions: issues: write already grants the automatic token, and the file falls back to it with a warning.

Docs only. node scripts/syntax-check.js 509 files OK; docs-show-commands 7/7, help-completeness 8/8, help-forms 81/81, docs-cli-transcript 9/9; check-doc-citations 370 citations, 0 beyond drift; doc-catalog-counts 43.

`docs/CI.md` says it is written from the workflows in `.forgejo/workflows/` — "if the two disagree the workflow is right and this page is a bug". `main-health.yml` landed there on 2026-11-20 (#2326) and the page never mentioned it. Three statements were untrue as a result: - **The trigger table** ended at `wiki-sync.yml`, so the job that turns a red `main` into an issue was undocumented; a reader of the page could not know it exists, what it opens, or that it writes issues at all. - **The badge advice** enumerates what `.forgejo/workflows/` holds — six files named, seven present. - **"Three workflows need to write"** had become four. The new row is written from the file: a 15-minute schedule plus a manual dispatch taking `sha` (default the head of `main`) and `dry_run` (default `true`); it reads the head's status set and opens one issue titled `main is red`, naming every failing check with the run link its status carries, reporting a given head once (the head is written into the issue body) and commenting and closing on the first green tick. It merges, rebases and arms nothing, and a tick that cannot read the status set warns instead of reporting `main` as fine. The token paragraph now separates the workflows that must *push* (which is why the secret exists) from `main-health.yml`, which only writes issues — `permissions: issues: write` already grants the automatic token, and the file falls back to it with a warning. Docs only. `node scripts/syntax-check.js` 509 files OK; docs-show-commands 7/7, help-completeness 8/8, help-forms 81/81, docs-cli-transcript 9/9; check-doc-citations 370 citations, 0 beyond drift; doc-catalog-counts 43.
docs(ci): the workflow table is missing the Main health job, and two lists of what lives in .forgejo/workflows are short (#2326)
All checks were successful
CI / Classify the change (pull_request) Successful in 15s
PR rebase / Rebase onto main and arm auto-merge (pull_request) Successful in 15s
CI / Server smoke and Docker build (pull_request) Has been skipped
CI / Test (Node 22) (pull_request) Successful in 57s
CI / Test (Node 20) (pull_request) Successful in 59s
CI / Test (Node 18) (pull_request) Successful in 1m3s
CI / Arm auto-merge (pull_request) Successful in 4s
00053e4625
docs/CI.md opens by saying it is written from the workflows in .forgejo/workflows/
and that a disagreement is this page's bug. main-health.yml landed in that
directory on 2026-11-20 (#2326) and no page named it: the trigger table stopped
at wiki-sync.yml, the badge advice enumerated six files where the directory now
holds seven, and 'three workflows need to write' had become four.

The row records what the file does, from the file: a 15-minute schedule and a
manual dispatch taking sha (default main's head) and dry_run (default true); it
reads main's head status set and opens one issue titled 'main is red' naming each
failing check with its run link, reports a given head once because the head is
written into the body, and comments and closes on the first green tick. It merges,
rebases and arms nothing, and a tick that cannot read the status set warns rather
than reporting main as fine.
forgejo-actions scheduled this pull request to auto merge when all checks succeed 2026-11-21 01:24:56 +00:00
jaylouisw deleted branch docs/1121-0117 2026-11-21 01:38:40 +00:00
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
jaylouisw/packetforge!2345
No description provided.