Skip to content

Commit 361b958

Browse files
authored
Merge pull request #81 from stacknil/stacknil/v0.5-release-readiness
docs(release): add v0.5 readiness checklist
2 parents 419ada9 + ee206ed commit 361b958

4 files changed

Lines changed: 25 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,8 @@ All notable user-visible changes should be recorded here.
4949
### Docs
5050

5151
- Added release notes for the v0.5 Evidence Explainability Release.
52+
- Added a release readiness checklist that maps v0.5 requirements to reviewer
53+
evidence and stopping points.
5254
- Added a one-page incident-style case that traces raw SSH evidence through
5355
normalized events and finding fields to a bounded conclusion.
5456
- Added a rule-by-rule false-positive taxonomy for NAT, bastion, internal scanner,

docs/parser-contract.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@ The guiding rule is:
66

77
> Parser observability > silent detection claims.
88
9+
For the v0.5 Evidence Explainability Release, this contract is part of the
10+
release-facing reviewer path. Start with [`docs/release-v0.5.0.md`](./release-v0.5.0.md)
11+
for the release checklist, then use this page to inspect supported inputs,
12+
unsupported-line handling, parser warning categories, and the detection signal
13+
boundary.
14+
915
## Supported input modes
1016

1117
| Mode | Typical source | Timestamp behavior | Review anchor |

docs/release-v0.5.0.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,19 @@ for reviewers to verify.
1818
- Added false-positive taxonomy and forensic-style case-study documentation for
1919
evidence interpretation.
2020

21+
## Release readiness checklist
22+
23+
| Requirement | Release-facing evidence | Reviewer check |
24+
| --- | --- | --- |
25+
| Changelog names v0.5.0 | [`CHANGELOG.md`](../CHANGELOG.md) | `v0.5.0` exists with explainability, parser observability, and case-study entries |
26+
| Release note theme is Evidence Explainability Release | This document | Title and highlights frame v0.5 around explainability and verification, not new rule volume |
27+
| Finding explainability fields are stable JSON contract | [`docs/report-artifacts.md`](./report-artifacts.md) and [`tests/fixtures/report_contracts/syslog_legacy/report.json`](../tests/fixtures/report_contracts/syslog_legacy/report.json) | Finding objects expose `rule_id`, `subject_kind`, `subject`, `grouping_key`, `window_start`, `window_end`, `threshold`, `observed_count`, `evidence_event_ids`, and `verdict_boundary` |
28+
| Parser contract is release-facing | [`docs/reviewer-path.md`](./reviewer-path.md) and [`docs/parser-contract.md`](./parser-contract.md) | Reviewer path routes v0.5 review through parser behavior, parser warnings, and detection signal boundaries |
29+
| Mixed corpus and parser coverage artifact are included | [`assets/mixed_auth_corpus.log`](../assets/mixed_auth_corpus.log) and [`assets/mixed_auth_parser_coverage.json`](../assets/mixed_auth_parser_coverage.json) | Reviewer can inspect dirty-input coverage without running the tool first |
30+
| False-positive taxonomy is included | [`docs/false-positive-taxonomy.md`](./false-positive-taxonomy.md) | Rule-true evidence is separated from compromise, intent, attribution, and authorization claims |
31+
| Forensic-style case study is included | [`docs/case-study-linux-auth-bruteforce.md`](./case-study-linux-auth-bruteforce.md) | Raw evidence, normalization, findings, warnings, and boundaries are explained as evidence interpretation |
32+
| Non-claims are explicit | [Non-claims](#non-claims) | Release note states no compromise verdict, no attribution, no blocking recommendation, and no cross-host correlation |
33+
2134
## Stable JSON contract
2235

2336
`report.json` now identifies the report artifact contract with:

docs/reviewer-path.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,10 @@ fields, explain how parser coverage remains visible for unknown lines, and state
5454
that findings are bounded triage signals with no compromise verdict,
5555
attribution, blocking recommendation, or cross-host correlation claim.
5656

57+
Use the release note's
58+
[`Release readiness checklist`](./release-v0.5.0.md#release-readiness-checklist)
59+
as the compact pass/fail map for the v0.5 scope.
60+
5761
## 5-minute artifact review
5862

5963
Inspect:

0 commit comments

Comments
 (0)