Skip to content

chore(AF-995): change-ticket documentation sweep - #1187

Merged
babltiga merged 1 commit into
mainfrom
chore/AF-995-change-ticket-docs
Oct 23, 2026
Merged

babltiga merged 1 commit into
mainfrom
chore/AF-995-change-ticket-docs

Conversation

@babltiga

Copy link
Copy Markdown
Contributor

Closes #995 (epic #989).

The documentation pass for deployment change tickets. #990–#994 each documented their own surface. This PR adds what none of them owned and fixes text they left stale.

What changed

  • docs/18-deployment-governance.md: a new §7 Change tickets. It covers the environment flag (which takes effect immediately), when a ticket opens, the one-ticket-per-channel rule, the stored verdict vs. the bidirectional_sync decision, the gate condition and its fail-closed cases, the break-glass audit key, and the limits (nothing is written back to the ticket; a submitter can approve their own ticket). The UI paragraph moved here from §5. Old §7–§10 are now §8–§11, with every anchor updated (incl. docs/05, docs/17, website/README.md). §1 and the module layout are updated too.
  • docs/07-security.md: the ServiceNow/Jira webhook paths added to the public-endpoint list (HMAC, timestamp tolerance, replay guard). Also a paragraph on deployment change tickets that states the ticket-actor gap as a control boundary.
  • docs/08: the stale "Outbound only — nothing reads back yet" bullet is replaced, and cross-links to §7 are added.
  • docs/03, docs/04: two stale "lands later" / "gate does not read it yet" sentences corrected. docs/03 gets a see-also link from query_tickets.
  • docs/12-roadmap.md: a v2.8 entry for the epic.
  • README.md: the notifications bullet, the deployment governance bullet and the docs/18 index row.
  • website/: notifications config (Jira change ticket), review-workflows (Environments text + figure), features hub, deployment-governance spoke (new paragraphs), homepage pitch line, roadmap page, deployment-approval guide (corrected the claim that a rejected ticket blocks "for good"), llms.txt. Dates bumped in all three places; help-corpus regenerated.
  • .claude/patterns/notification-fanout.md: the ticketing-trigger row notes that a trigger can map to several events, and how the headline builder handles deployments.
  • e2e/screenshots/capture.ts: the seed now flags production as needing a change ticket. The rollback chain moved to staging, because with no ticketing channel seeded, production's gate stays closed.

Not changed: website/llms.txt:70 (the guide line the issue named). That guide's own description doesn't mention tickets, so I updated the features and docs/18 lines instead.

Screenshots

Environments tab with the Change ticket column
Deployment detail with the Change ticket card
Deployments list with the Ticket column

Verification

  • npx vitest run src/config/__tests__/ (website guards): 116/116. I trimmed the homepage line to stay under its 1300-word budget.
  • node .github/scripts/build-help-corpus.mjs: regenerated and committed.
  • Anchor sweep: no stale docs/18 section references.

Review notes

  • af-content-reviewer: Blocker. docs/18 said the flag "changes nothing until a channel opens tickets", which is false: it closes the gate at once. Fixed. Concerns about the spoke page hiding the inbound-rule step, and "sync both ways" contradicting create-only, are also fixed.
  • af-reviewer: Blocker. The seed flag broke the rollback screenshot chain (409 on confirm). Fixed by moving the chain to staging and re-capturing. Stale sentences in docs/03 and docs/04 are fixed. Concern: "a rejected ticket blocks for good" is wrong, because only an approval is sticky. Fixed in docs/18 and the guide.
  • Remaining nit, not taken: the "Verified 2026-08-12" header on the fanout pattern table, since only one row was re-derived.

@github-actions

Copy link
Copy Markdown
Contributor

Frontend Test Results

    1 files  ±0    342 suites  ±0   9m 47s ⏱️ + 2m 1s
2 980 tests ±0  2 980 ✅ ±0  0 💤 ±0  0 ❌ ±0 
2 981 runs  ±0  2 981 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit 541bd61. ± Comparison against base commit 7bc919e.

@github-actions

Copy link
Copy Markdown
Contributor

Coverage Report for Frontend Coverage (frontend)

Status Category Percentage Covered / Total
🟢 Lines 96.56% (🎯 90%) 4333 / 4487
🟢 Statements 95.31% (🎯 90%) 4785 / 5020
🟢 Functions 94.84% (🎯 90%) 1324 / 1396
🟢 Branches 89.12% (🎯 80%) 3106 / 3485
File CoverageNo changed files found.
Generated in workflow #1603 for commit 541bd61 by the Vitest Coverage Report Action

@github-actions

Copy link
Copy Markdown
Contributor

Backend Test Results

11 416 tests  ±0   11 416 ✅ ±0   12m 14s ⏱️ - 1m 10s
 1 219 suites ±0        0 💤 ±0 
 1 219 files   ±0        0 ❌ ±0 

Results for commit 541bd61. ± Comparison against base commit 7bc919e.

@github-actions

Copy link
Copy Markdown
Contributor

Backend Code Coverage

Overall Project 95.16% 🍏

There is no coverage information present for the Files changed

@babltiga
babltiga merged commit ef62d38 into main Oct 23, 2026
16 checks passed
@babltiga
babltiga deleted the chore/AF-995-change-ticket-docs branch October 23, 2026 08:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

deploygov: change-ticket documentation sweep

1 participant