docs(#1808): add THREAT_MODEL.md to change checklist for trust-boundary mods - #1809
docs(#1808): add THREAT_MODEL.md to change checklist for trust-boundary mods#1809fullsend-ai-coder[bot] wants to merge 1 commit into
Conversation
…ry mods Add a "Security Documentation Maintenance" section to AGENTS.md that instructs PR authors to check and update THREAT_MODEL.md when modifying trust-boundary code in policy/lib/tekton/. Lists the key THREAT_MODEL.md sections to verify: Section 3.3 (trusted task data flow), threat entries DP-2 and LE-4, the security-critical rule data keys table, and open questions referencing changed components. Placed adjacent to the existing "Review Checklist for New Policy Rules" section since both serve as pre-merge checklists. Closes #1808
|
🤖 Finished Review · ✅ Success · Started 1:53 PM UTC · Completed 2:06 PM UTC Commit: |
Codecov Report✅ All modified and coverable lines are covered by tests.
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
ReviewFindingsMedium
Low
Labels: PR modifies documentation governance file (AGENTS.md) with process guidance content |
![fullsend-ai-review[bot]](https://avatars.githubusercontent.com/in/3478501?s=60&v=4){kind=small}
| that handle trusted task rules, data input paths, or merge/validation logic — | ||
| check whether `THREAT_MODEL.md` describes the affected architecture. If it does, | ||
| update the relevant sections in the same PR. Key sections to check: | ||
|
|
There was a problem hiding this comment.
[low] technical documentation accuracy
The new section references 'Section 3.3 (trusted task data flow and merge architecture)' but the actual THREAT_MODEL.md heading is '### 3.3 Trusted task data (data.trusted_tasks, data.trusted_task_rules)'. The phrase 'merge architecture' does not appear in THREAT_MODEL.md. Additionally, THREAT_MODEL.md section 3.3 is itself currently stale — it still references data.trusted_task_rules which was removed in PR #1806. The new guidance points authors to a section containing outdated information.
Suggested fix: Consider using the exact section number ('Section 3.3') without the paraphrase, and either fix the staleness in THREAT_MODEL.md section 3.3 in this PR or reference a follow-up issue to track that work.
fullsend-ai-review
Bot
added
requires-manual-review
What:
Add a "Security Documentation Maintenance" section to AGENTS.md that guides PR authors to check and update THREAT_MODEL.md when modifying trust-boundary code.
Why:
PR #1806 made structural changes to trusted task rules (removing
data.trusted_task_rulespath) but left THREAT_MODEL.md stale in 9+ locations. The review agent caught it post-hoc, but there was no preventive guidance for PR authors. This adds an explicit checklist item so that future PRs modifying trust-boundary code inpolicy/lib/tekton/include THREAT_MODEL.md updates when the document references the affected architecture.Key THREAT_MODEL.md sections to check are listed:
Tickets:
Closes #1808
Post-script verification
agent/1808-add-threat-model-checklist)4b089513609ae33616c01509cb0a0ccc5db4fb11..HEAD)