Files

T

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

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.

2026-10-10 11:34:13 +08:00

3.3 KiB

Raw Blame History

Review Record: ADR-0004 Opt-in rule and secret handling of the shared wiki publisher

Metadata

Key	Value
ID	RC-018
CrossReference	ADR-0004, QC-ADR-001

Version History

Date	Status	Author	Reviewer	Change	Commit
2026-10-10	Accepted	Jens Tirsvad Nielsen	S01	Initial version	pending

Artifact Under Review

Instance reviewed: ADR-0004
Checklist used: QC-ADR-001

Checklist Results

#	Criterion	Status	Evidence/Notes
1	The ID (`ADR-NNNN`, 4-digit) matches the filename number and is unique and sequential	Pass	ADR-0004 in `adr-0004-shared-wiki-publishing-opt-in.md`; follows ADR-0003.
2	Context states the problem, the forces (cost, risk, constraints) and the options evaluated	Pass	States the scoped delivery, the deletion risk, the per-organisation secret and the fallback.
3	At least two options were considered, or the absence of alternatives is justified	Pass	Four options for opting in (one with two forms) and two for the secret.
4	Decision is stated in one or two unhedged sentences and matches one of the evaluated options	Pass	Finding fixed during this review: the `prune` form was not among the evaluated options. It is now option 1(b), with the reason. The decision is two sentences.
5	Consequences list both Positive and Negative outcomes	Pass	Three positive, four negative.
6	Quality-attribute impacts (performance, security, portability, etc.) are named where the decision affects them	Pass	Security is named: no write without opt-in, no write access for the sync token, write access of anyone with repository write rights.
7	Affected Artifacts are listed as links, and each is also in CrossReference	Pass	MIL-006, ADR-0003 and ADR-0002 are linked and cited.
8	Status changes are recorded as new Version History rows with a Change summary and Commit link; retained rows are never rewritten	Pass	The earlier row is kept and only its status changed.
9	A superseded or deprecated ADR names its successor, and the successor links back	N-A	ADR-0003 is superseded only in part and stays in force for this repository's local workflow until MIL-006 task 2 lands; see the action item.
10	Written in business or technical language of the domain, with no unexplained abbreviations	Pass	IT Professional English; `prune` and the marker are explained where they are introduced.
11	Status is one of `Proposed`, `Accepted`, `Rejected`, `Deprecated` or `Superseded by ADR-NNNN`, and every Version History row uses only these	Pass	Deprecated and Accepted only.

Overall Verdict

Go - all applicable criteria pass; the one finding (criterion 4) was fixed during the review. S01 gave the Go in chat on 2026-10-10, standing in for the other reviewers as ADR-0002 records; there is no independent reader.

Action Items

Action	Owner	Due
When MIL-006 task 2 (#57) merges, mark ADR-0003 as superseded by ADR-0004 for the shared workflow (new version row and review record)	S01	2026-12-26
Choose the pilot repository (MIL-006 task 4, already an action item in RC-016)	S01	2026-12-14

3.3 KiB Raw Blame History