Skip to content

Commit 8a31614

Browse files
committed
Added changelog to documentation site
1 parent 3fb726f commit 8a31614

3 files changed

Lines changed: 96 additions & 0 deletions

File tree

docs/docs/changelogs/index.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
title: Changelogs
2+
description: Release changelogs for OracleTrace.
3+
keywords: oracletrace changelog, oracletrace releases, release notes
4+
og_title: OracleTrace Changelogs
5+
og_description: Release changelogs and notes for OracleTrace.
6+
7+
# Changelogs
8+
9+
This section tracks OracleTrace releases and notable changes.
10+
11+
## Available releases
12+
13+
- [v2.0.0](v2-0-0.md)

docs/docs/changelogs/v2-0-0.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
title: OracleTrace v2.0.0 Changelog
2+
description: Release notes and changelog for OracleTrace v2.0.0.
3+
keywords: oracletrace v2.0.0, oracletrace changelog, oracletrace release notes
4+
og_title: OracleTrace v2.0.0 Changelog
5+
og_description: Release notes and changelog for OracleTrace v2.0.0.
6+
7+
# OracleTrace v2.0.0 - Release Notes
8+
9+
**Date:** 2026-04-09
10+
11+
This release consolidates major improvements across the CLI, performance regression workflows, test coverage, and documentation, with a strong focus on practical local usage and CI automation.
12+
13+
## Summary
14+
15+
OracleTrace 2.0.0 introduces:
16+
17+
- New analysis and output controls (`--csv`, `--ignore`, `--top`)
18+
- CI regression gating (`--fail-on-regression` + `--threshold`)
19+
- Tracer improvements (including qualified function naming and timing)
20+
- Automated CLI test coverage with `pytest`
21+
- Expanded and fully aligned documentation
22+
23+
## Changelog
24+
25+
### Added
26+
27+
- CSV export for trace results (`--csv`)
28+
- Regex-based filtering for functions/paths (`--ignore`)
29+
- Top-N summary limiting (`--top`)
30+
- Regression fail mode for pipelines (`--fail-on-regression`)
31+
- Configurable regression threshold (`--threshold`)
32+
- Automated CLI tests with `pytest`
33+
- CI workflow running tests across multiple Python versions
34+
- Issue and Pull Request templates for contribution consistency
35+
36+
### Improved
37+
38+
- Clearer total execution timing in tracer output
39+
- Fully qualified function naming with `co_qualname` for better trace identity
40+
- More robust baseline vs current comparison flow for regression validation
41+
- More predictable CLI error and exit behavior for automation
42+
43+
### Documentation
44+
45+
- CLI Reference updated with current flags and usage
46+
- Examples expanded (CSV export, ignore/top usage, CI regression gate)
47+
- Quickstart updated with baseline/compare and optional CI gate flow
48+
- README updated to reflect current features and recommended commands
49+
- CONTRIBUTING updated to reflect the existing automated test suite
50+
51+
### Fixes / Maintenance
52+
53+
- Test workflow maintenance updates (including runtime matrix adjustments)
54+
- `.gitignore` update for generated docs paths
55+
- Maintainer/contributor information updates
56+
57+
## Compatibility and Migration Notes
58+
59+
- Requirement remains: **Python >= 3.10**
60+
- Existing baseline + compare workflows remain valid
61+
- No mandatory breaking migration for existing users
62+
- For CI, recommended command pattern is:
63+
- `--fail-on-regression`
64+
- `--threshold` tuned to your tolerance (for example `10` or `25`)
65+
66+
## Recommended CI Command
67+
68+
```bash
69+
oracletrace app.py --json current.json --compare baseline.json --fail-on-regression --threshold 10
70+
```
71+
72+
## Upgrade
73+
74+
```bash
75+
pip install --upgrade oracletrace
76+
```
77+
78+
## Thanks
79+
80+
Thanks to all contributors who helped ship this release across features, docs, tests, and repository infrastructure.

docs/mkdocs.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,9 @@ nav:
4343
- Quickstart: quickstart.md
4444
- CLI Reference: cli-reference.md
4545
- Examples: examples.md
46+
- Changelogs:
47+
- Overview: changelogs/index.md
48+
- v2.0.0: changelogs/v2-0-0.md
4649

4750
markdown_extensions:
4851
- meta

0 commit comments

Comments
 (0)