Decide the opt-in rule and secret handling of the shared wiki publisher (ADR-0004) #61

Merged
Tirsvad merged 2 commits from mil-006-adr-0004 into main 2026-10-10 05:34:49 +02:00
Owner

Decides the opt-in rule and the secret handling of the shared wiki publisher (MIL-006 task 1, issue #56).

Decision (ADR-0004, Accepted)

  • A repository opts in by committing wiki/.publish on its default branch. The file may contain the single word prune, which is the only thing that lets the workflow delete wiki pages that are not in wiki/. Without the marker the workflow ends successfully without any request.
  • The shared workflow uses the organisation's TOKEN_FOR_GITEA_WIKI only, and fails with a configuration error when a repository has opted in and the secret is missing. The fallback to TOKEN_FOR_GITEA of ADR-0003 is removed from the shared workflow.
  • An empty wiki/ never deletes anything. This repository will commit wiki/.publish containing prune.

Options weighed: marker file (alone, or with prune), repository variable, allow list, publish whenever wiki/ exists; and the organisation's wiki secret only, or a fallback to the sync token.

Review and documents

  • RC-018 (QC-ADR-001): 10 Pass, 1 N-A, Go. One finding fixed in the review: the prune form was not among the evaluated options, so it is now option 1(b) with the reason.
  • TM-001 lists ADR-0004 and RC-018; the registry's next numbers are RC 019 and ADR 0005.
  • PP-001 links the MIL-006 milestone (94), a content update without a new version row, as PP.md describes.

Review status

  • S01 gave the Go, standing in as ADR-0002 records; there is no independent reader.
  • Action items: when #57 merges, mark ADR-0003 as superseded by ADR-0004 for the shared workflow (S01, 2026-12-26); choose the pilot repository (S01, 2026-12-14).

Not in this PR

No code. Tasks 2 and 3 (issues #57 and #58) implement this decision.

Closes #56

Decides the opt-in rule and the secret handling of the shared wiki publisher (MIL-006 task 1, issue #56). ## Decision (ADR-0004, `Accepted`) - A repository opts in by committing `wiki/.publish` on its default branch. The file may contain the single word `prune`, which is the only thing that lets the workflow delete wiki pages that are not in `wiki/`. Without the marker the workflow ends successfully without any request. - The shared workflow uses the organisation's `TOKEN_FOR_GITEA_WIKI` only, and fails with a configuration error when a repository has opted in and the secret is missing. The fallback to `TOKEN_FOR_GITEA` of ADR-0003 is removed from the shared workflow. - An empty `wiki/` never deletes anything. This repository will commit `wiki/.publish` containing `prune`. Options weighed: marker file (alone, or with `prune`), repository variable, allow list, publish whenever `wiki/` exists; and the organisation's wiki secret only, or a fallback to the sync token. ## Review and documents - **RC-018** (QC-ADR-001): 10 Pass, 1 N-A, Go. One finding fixed in the review: the `prune` form was not among the evaluated options, so it is now option 1(b) with the reason. - TM-001 lists ADR-0004 and RC-018; the registry's next numbers are RC 019 and ADR 0005. - PP-001 links the MIL-006 milestone (94), a content update without a new version row, as `PP.md` describes. ## Review status - S01 gave the Go, standing in as ADR-0002 records; there is no independent reader. - Action items: when #57 merges, mark ADR-0003 as superseded by ADR-0004 for the shared workflow (S01, 2026-12-26); choose the pilot repository (S01, 2026-12-14). ## Not in this PR No code. Tasks 2 and 3 (issues #57 and #58) implement this decision. Closes #56
Tirsvad added 2 commits 2026-10-10 05:34:20 +02:00
A repository opts in with wiki/.publish; the word prune in it is the only
thing that lets the workflow delete pages. The shared workflow uses the
organisation's TOKEN_FOR_GITEA_WIKI only. Review and accept it (RC-018),
update TM-001 and link the MIL-006 milestone in PP-001.
Resolve pending commit links in ADR-0004, RC-018 and TM-001
Validate workflows / validate (pull_request) Successful in 15s
92396e23c9
Tirsvad merged commit 439de4ac60 into main 2026-10-10 05:34:49 +02:00
Tirsvad deleted branch mil-006-adr-0004 2026-10-10 05:34:50 +02:00
Sign in to join this conversation.