Skip to content

feat: add performance overhead benchmark, link checker & prepare v0.2.5 - #25

Merged
MUDASSIR-75 merged 7 commits into
ENDEVSOLS:mainfrom
Abdullahbinmushtaq:feat/v0.2.5-performance-baseline
Nov 13, 2026
Merged

MUDASSIR-75 merged 7 commits into
ENDEVSOLS:mainfrom
Abdullahbinmushtaq:feat/v0.2.5-performance-baseline

Conversation

@Abdullahbinmushtaq

Copy link
Copy Markdown
Contributor

Summary

Implements the deliverables for v0.2.5, replacing anecdotal overhead claims with a reproducible benchmark harness, verifying documentation links, and entering feature freeze ahead of the v0.3.0 stable release.

Key Changes

  • Overhead Benchmark Harness (tests/benchmarks/): Added a 1,000-step synthetic stream generator and runner to measure per-step check latency across all detectors and embedder backends.
  • CI Benchmark Job: Added a GitHub Actions workflow job to run the benchmark on Ubuntu (Python 3.12) and save the report as an artifact.
  • Documentation Updates:
    • Added docs/performance.md explaining the benchmark methodology, memory profile, and local reproduction steps.
    • Updated README.md to reflect measured performance and distinguish hash-based embeddings from neural embeddings.
    • Added a "Roadmap & Release Plan" section to both README.md and CONTRIBUTING.md.
  • Link Checker (scripts/check_links.py): Added automated validation for local markdown links and anchors, wired into CI and release gates.
  • Release Preparation: Bumped package version to 0.2.5, updated CHANGELOG.md, and locked runtime changes for feature freeze.

Compatibility

  • Zero runtime behavior change: Detectors, circuit breaker logic, defaults, budget boundaries, and public APIs remain unchanged.

@MUDASSIR-75
MUDASSIR-75 merged commit 3e0d9af into ENDEVSOLS:main Nov 13, 2026
12 checks passed
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.

2 participants