Skip to content

Commit bd5ccc5

Browse files
Release 0.11.1 (#103)
* Release 0.11.1 * Moving the tracing example to the rootcause-tracing crate
1 parent f5b7dea commit bd5ccc5

11 files changed

Lines changed: 57 additions & 52 deletions

File tree

CHANGELOG.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,27 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [Unreleased]
99

10+
## [0.11.1] - 2026-01-03
11+
1012
### Added
1113

1214
- Added a `OptionExt` trait [#92](https://github.com/rootcause-rs/rootcause/pull/92)
13-
- Add a `rootcause::Result` type alias [#91](https://github.com/rootcause-rs/rootcause/pull/91)
15+
- Added a `rootcause::Result` type alias [#91](https://github.com/rootcause-rs/rootcause/pull/91)
16+
- Added methods to get the type name of contexts and attachments [#100](https://github.com/rootcause-rs/rootcause/pull/100)
17+
- Implements `Clone` for `Backtrace` and `Display` for `Location` [#100](https://github.com/rootcause-rs/rootcause/pull/100)
18+
- Added `ReportMut::attach` and `ReportMut::attach_custom` [#101](https://github.com/rootcause-rs/rootcause/pull/101)
19+
- Added a `rootcause-tracing` crate [#102](https://github.com/rootcause-rs/rootcause/pull/102)
1420

1521
### Fixed
1622

17-
- Add `#[track_caller]` to two functions that were missing them [#89](https://github.com/rootcause-rs/rootcause/pull/89)
23+
- Added `#[track_caller]` to two functions that were missing them [#89](https://github.com/rootcause-rs/rootcause/pull/89)
1824

1925
## [0.11.0] - 2025-12-12
2026

2127
### Added
2228

23-
- Add a compatibility module for boxed errors [#70](https://github.com/rootcause-rs/rootcause/pull/70)
24-
- Add a compatibility module for error-stack v0.5 [#75](https://github.com/rootcause-rs/rootcause/pull/75)
29+
- Added a compatibility module for boxed errors [#70](https://github.com/rootcause-rs/rootcause/pull/70)
30+
- Added a compatibility module for error-stack v0.5 [#75](https://github.com/rootcause-rs/rootcause/pull/75)
2531
- Added a `ReportConversion` trait along with `context_to`, `context_transform` and `context_transform_nested` methods [#83](https://github.com/rootcause-rs/rootcause/pull/83)
2632

2733
### Changed
@@ -160,7 +166,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
160166

161167
- Initial release
162168

163-
[Unreleased]: https://github.com/rootcause-rs/rootcause/compare/v0.11.0...HEAD
169+
[Unreleased]: https://github.com/rootcause-rs/rootcause/compare/v0.11.1...HEAD
170+
[0.11.1]: https://github.com/rootcause-rs/rootcause/compare/v0.11.0...v0.11.1
164171
[0.11.0]: https://github.com/rootcause-rs/rootcause/compare/v0.10.0...v0.11.0
165172
[0.10.0]: https://github.com/rootcause-rs/rootcause/compare/v0.9.1...v0.10.0
166173
[0.9.1]: https://github.com/rootcause-rs/rootcause/compare/v0.9.0...v0.9.1

Cargo.lock

Lines changed: 26 additions & 26 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "rootcause"
3-
version = "0.11.0"
3+
version = "0.11.1"
44
edition = "2024"
55
license = "MIT/Apache-2.0"
66
categories = ["rust-patterns", "no-std"]
@@ -35,7 +35,7 @@ error-stack05 = { package = "error-stack", version = "0.5.0", default-features =
3535
eyre = { version = "0.6.12", default-features = false, optional = true }
3636

3737
# Internal dependencies
38-
rootcause-internals = { path = "rootcause-internals", version = "=0.11.0" }
38+
rootcause-internals = { path = "rootcause-internals", version = "=0.11.1" }
3939

4040
[dev-dependencies]
4141
derive_more = { version = "2.1.0", default-features = false, features = [
@@ -45,7 +45,6 @@ derive_more = { version = "2.1.0", default-features = false, features = [
4545
] }
4646
eyre = { version = "0.6.12", features = ["auto-install"] }
4747
indexmap = "2.12.0"
48-
rootcause-tracing = { path = "rootcause-tracing", version = "=0.11.0" }
4948
serde_json = "1.0.145"
5049
static_assertions = "1.1.0"
5150
thiserror = "2.0.17"

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,7 @@ Add this to your `Cargo.toml`:
226226

227227
```toml
228228
[dependencies]
229-
rootcause = "0.11.0"
229+
rootcause = "0.11.1"
230230
```
231231

232232
Use `Report` as your error type:
@@ -293,18 +293,20 @@ Once you're comfortable with the basics, rootcause offers powerful features for
293293
The rootcause ecosystem consists of multiple crates:
294294

295295
**Core:**
296+
296297
- **`rootcause`** - The main user-facing API with type-safe abstractions. Uses type markers to ensure the underlying data structures are used safely.
297298
- **`rootcause-internals`** - Low-level data structures and memory management. Handles the actual report storage, allocations, and pointer manipulation.
298299

299300
**Extensions:**
301+
300302
- **`rootcause-backtrace`** - Optional backtrace capture support. Provides hooks for automatic stack trace collection.
301303
- **`rootcause-tracing`** - Optional tracing span capture. Provides hooks to attach active tracing spans to error reports.
302304

303305
The split between `rootcause` and `rootcause-internals` provides a clean API boundary: internals define how data is stored, while the main crate ensures that storage is accessed safely through Rust's type system. This makes it easy to understand the underlying representation while keeping the safe API ergonomic. Extensions integrate via the hook system without requiring changes to core.
304306

305307
## Stability and Roadmap
306308

307-
**Current status:** Pre-1.0 (v0.11.0)
309+
**Current status:** Pre-1.0 (v0.11.1)
308310

309311
rootcause follows semantic versioning. As a 0.x library, breaking changes may occur in minor version bumps (0.x → 0.x+1). We're actively refining the API based on real-world usage and focused on reaching 1.0.
310312

RELEASE-CHECKLIST.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22
- `Cargo.toml`
33
- `rootcause-internals/Cargo.toml`
44
- `rootcause-backtrace/Cargo.toml`
5+
- `rootcause-tracing/Cargo.toml`
56
- `README.md`
7+
- `rootcause-tracing/README.md`
68
- Grep for the old version number
79
- Update CHANGELOG.md, including the links at the bottom
810
- Run `cargo update`

examples/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Demonstrations of rootcause features and patterns.
5353

5454
## Tracing Integration
5555

56-
- [`tracing_spans.rs`](tracing_spans.rs) - Automatic span capture with full hierarchy and field values
56+
- [`tracing_spans.rs`](../rootcause-tracing/examples/tracing_spans.rs) - Automatic span capture with full hierarchy and field values
5757

5858
## Running Examples
5959

rootcause-backtrace/Cargo.toml

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,10 @@
11
[package]
22
name = "rootcause-backtrace"
3-
version = "0.11.0"
3+
version = "0.11.1"
44
edition = "2024"
55
license = "MIT/Apache-2.0"
66
categories = ["rust-patterns"]
7-
keywords = [
8-
"error",
9-
"error-handling",
10-
"ergonomic",
11-
"library",
12-
"backtrace",
13-
]
7+
keywords = ["error", "error-handling", "ergonomic", "library", "backtrace"]
148
description = "Backtraces support for the rootcause error reporting library"
159
repository = "https://github.com/rootcause-rs/rootcause"
1610
documentation = "https://docs.rs/rootcause-backtrace"
@@ -25,4 +19,4 @@ regex = { version = "1.12.2", default-features = false }
2519
unicode-ident = "1.0.22"
2620

2721
# Internal dependencies
28-
rootcause = { path = "../", version = "=0.11.0" }
22+
rootcause = { path = "../", version = "=0.11.1" }

rootcause-internals/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "rootcause-internals"
3-
version = "0.11.0"
3+
version = "0.11.1"
44
edition = "2024"
55
license = "MIT/Apache-2.0"
66
description = "Internals for the rootcause crate"

rootcause-tracing/Cargo.toml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "rootcause-tracing"
3-
version = "0.11.0"
3+
version = "0.11.1"
44
edition = "2024"
55
license = "MIT/Apache-2.0"
66
categories = ["rust-patterns", "development-tools::debugging"]
@@ -17,9 +17,10 @@ tracing-subscriber = { version = "0.3.22", default-features = false, features =
1717
] }
1818

1919
# Internal dependencies
20-
rootcause = { path = "../", version = "=0.11.0" }
20+
rootcause = { path = "../", version = "=0.11.1" }
2121

2222
[dev-dependencies]
23+
thiserror = "2.0.17"
2324
tracing = { version = "0.1.44", default-features = true, features = [
2425
"attributes",
2526
] }

rootcause-tracing/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ Add to your `Cargo.toml`:
2222

2323
```toml
2424
[dependencies]
25-
rootcause = "0.11.0"
26-
rootcause-tracing = "0.11.0"
25+
rootcause = "0.11.1"
26+
rootcause-tracing = "0.11.1"
2727
tracing = "0.1.44"
2828
tracing-subscriber = "0.3.22"
2929
```
@@ -154,7 +154,7 @@ With nested instrumented functions, each error captures the full span hierarchy
154154
╰─
155155
```
156156

157-
Spans are ordered innermost to outermost. See [`examples/tracing_spans.rs`](../examples/tracing_spans.rs) for a complete example.
157+
Spans are ordered innermost to outermost. See [`examples/tracing_spans.rs`](examples/tracing_spans.rs) for a complete example.
158158

159159
## Configuration
160160

0 commit comments

Comments
 (0)