Skip to content

Commit d7fcdac

Browse files
committed
docs: prep v0.3.0 release notes
1 parent ac272a5 commit d7fcdac

File tree

3 files changed

+46
-7
lines changed

3 files changed

+46
-7
lines changed

CHANGELOG.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,7 @@ All notable user-visible changes should be recorded here.
66

77
### Added
88

9-
- Added sanitized golden `report.md` / `report.json` regression fixtures to lock report contracts.
10-
- Expanded parser coverage for `Accepted publickey` and selected `pam_faillock` / `pam_sss` variants.
11-
- Added compact host-level summaries for multi-host reports.
12-
- Added optional CSV export for findings and warnings when explicitly requested.
9+
- None yet.
1310

1411
### Changed
1512

@@ -23,6 +20,27 @@ All notable user-visible changes should be recorded here.
2320

2421
- None yet.
2522

23+
## v0.3.0
24+
25+
### Added
26+
27+
- Broadened parser support for common Linux auth families by adding `Accepted publickey` handling plus selected `pam_faillock` and `pam_sss` auth failure variants.
28+
- Added compact host-level summaries to `report.md` and `report.json` for multi-host inputs.
29+
- Added optional CSV export for findings and warnings behind an explicit `--csv` flag.
30+
- Added sanitized golden report-contract fixtures to lock deterministic Markdown, JSON, and CSV outputs.
31+
32+
### Changed
33+
34+
- Strengthened sanitized regression coverage with expanded parser fixture corpora and golden report-contract checks.
35+
36+
### Fixed
37+
38+
- Non-CSV runs now preserve pre-existing `findings.csv` and `warnings.csv` files instead of deleting them by default.
39+
40+
### Docs
41+
42+
- Synced release-facing documentation in `README.md` and added `docs/release-v0.3.0.md` for GitHub Release copy.
43+
2644
## v0.2.0
2745

2846
### Added

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ LogLens includes two minimal GitHub Actions workflows:
3636
- `CI` builds and tests the project on `ubuntu-latest` and `windows-latest`
3737
- `CodeQL` runs GitHub code scanning for C/C++ on pushes, pull requests, and a weekly schedule
3838

39-
Both workflows are intended to stay stable enough to require on pull requests to `main`. Release-facing documentation is split across [`CHANGELOG.md`](./CHANGELOG.md), [`docs/release-process.md`](./docs/release-process.md), [`docs/release-v0.1.0.md`](./docs/release-v0.1.0.md), and the repository's GitHub release notes. The repository hardening note is in [`docs/repo-hardening.md`](./docs/repo-hardening.md), and vulnerability reporting guidance is in [`SECURITY.md`](./SECURITY.md).
39+
Both workflows are intended to stay stable enough to require on pull requests to `main`. Regression coverage is backed by sanitized parser fixture matrices plus golden report-contract fixtures for `report.md`, `report.json`, and optional CSV outputs. Release-facing documentation is split across [`CHANGELOG.md`](./CHANGELOG.md), [`docs/release-process.md`](./docs/release-process.md), [`docs/release-v0.1.0.md`](./docs/release-v0.1.0.md), [`docs/release-v0.3.0.md`](./docs/release-v0.3.0.md), and the repository's GitHub release notes. The repository hardening note is in [`docs/repo-hardening.md`](./docs/repo-hardening.md), and vulnerability reporting guidance is in [`SECURITY.md`](./SECURITY.md).
4040

4141
## Threat Model
4242

@@ -58,7 +58,7 @@ LogLens currently detects:
5858
- One IP trying multiple usernames within 15 minutes
5959
- Bursty sudo activity from the same user within 5 minutes
6060

61-
LogLens currently parses and reports these additional auth patterns beyond the core detector inputs:
61+
LogLens currently parses and reports these additional auth patterns beyond the core detector inputs, broadening coverage across common Linux auth families:
6262

6363
- `Accepted publickey` SSH successes
6464
- `Failed publickey` SSH failures, which count toward SSH brute-force detection by default
@@ -121,7 +121,7 @@ The CSV schema is intentionally small and stable:
121121
- `findings.csv`: `rule`, `subject_kind`, `subject`, `event_count`, `window_start`, `window_end`, `usernames`, `summary`
122122
- `warnings.csv`: `kind`, `message`
123123

124-
When an input spans multiple hostnames, both reports add compact host-level summaries without changing detector thresholds or introducing cross-host correlation logic.
124+
When an input spans multiple hostnames, both reports add compact host-level summaries without changing detector thresholds or introducing cross-host correlation logic. In `report.md` this appears as a host summary table, and in `report.json` it appears as a `host_summaries` array.
125125

126126
## Sample Output
127127

docs/release-v0.3.0.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# LogLens v0.3.0
2+
3+
LogLens v0.3.0 expands parser family coverage, strengthens deterministic regression coverage, and improves multi-host reporting while keeping the tool intentionally defensive and public-safe.
4+
5+
## Highlights
6+
7+
- broadened parser support for common Linux auth families
8+
- strengthened sanitized corpus and golden regression coverage
9+
- added multi-host host summaries in `report.md` and `report.json`
10+
- added optional CSV export for findings and warnings
11+
12+
## Notable changes
13+
14+
- added parser support for `Accepted publickey` SSH successes plus selected `pam_faillock(...:auth)` and `pam_sss(...:auth)` failure variants
15+
- expanded sanitized parser fixture matrices and added golden report-contract fixtures for Markdown, JSON, and CSV outputs
16+
- added compact per-host summaries when one input file contains multiple hostnames, without introducing cross-host correlation or changing detector thresholds
17+
- added explicit `--csv` output for `findings.csv` and `warnings.csv`, and kept non-CSV runs non-destructive toward existing CSV files
18+
19+
## Scope note
20+
21+
This release broadens the parser surface and improves report ergonomics, but LogLens remains a focused offline auth-log triage CLI rather than a SIEM, enrichment pipeline, or cross-host correlation platform.

0 commit comments

Comments
 (0)