petgraph-live 0.3.1

Generic generation-keyed graph cache, disk snapshot, and graph algorithms for petgraph 0.8
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124

# Release

## Distribution

Published to [crates.io](https://crates.io/crates/petgraph-live).

```toml
[dependencies]
petgraph-live = "0.3"

# With snapshot support:
petgraph-live = { version = "0.3", features = ["snapshot"] }

# With zstd compression:
petgraph-live = { version = "0.3", features = ["snapshot-zstd"] }

# With LZ4 compression:
petgraph-live = { version = "0.3", features = ["snapshot-lz4"] }
```

## Branch Strategy

`main` is always releasable — tagged commits only. Feature work lands on a
`release/vX.Y.Z` integration branch, not directly on `main`.

```
feat/xxx  ─┐
feat/yyy  ─┼─▶  release/vX.Y.Z  ─▶  main  (tag vX.Y.Z)
feat/zzz  ─┘
```

1. Open `release/vX.Y.Z` from `main` at the start of the milestone.
2. Each `feat/...` PR targets `release/vX.Y.Z`, not `main`.
3. Run the pre-release checklist as commits on `release/vX.Y.Z`.
4. One final PR merges `release/vX.Y.Z` → `main`; tag on the merge commit.

Hotfixes branch from the relevant tag and merge back to both `main` and the
active `release/` branch if one is open.

## Pre-Release Checklist

### Feature matrix — all combinations must pass

```bash
cargo test
cargo test --features snapshot
cargo test --features snapshot-zstd
cargo test --features snapshot-lz4
cargo test --features snapshot-zstd,snapshot-lz4
```

### Code quality

- [ ] All tests pass (all three feature combinations above)
- [ ] Formatted: `cargo fmt -- --check`
- [ ] No lint issues: `cargo clippy --all-targets --all-features -- -D warnings`
- [ ] Examples compile and run without panic: `cargo run --example cache_basic && cargo run --example connect && cargo run --example metrics && cargo run --example mst && cargo run --example shortest_path && cargo run --example snapshot_basic --features snapshot && cargo run --example live_basic --features snapshot`
- [ ] Doc tests pass: `cargo test --doc --all-features`

### Documentation

- [ ] All spec files in `docs/specifications/` have `status: implemented`
- [ ] `CHANGELOG.md` section dated and complete
- [ ] Public types have `///` rustdoc comments
- [ ] `docs/api-design.md` matches actual public API

### Version

- [ ] Version bumped in `Cargo.toml`
- [ ] `Cargo.lock` updated: `cargo update -p petgraph-live`

## Release

```bash
# 1. Bump version in Cargo.toml, update CHANGELOG date

# 2. Commit on release branch, push, open PR
git commit -am "chore: release vx.y.z"
git push origin release/vx.y.z
gh pr create --title "chore: release vx.y.z" --base main

# 3. Wait for PR CI to pass, then merge to main
git checkout main
git merge --no-ff release/vx.y.z

# 4. Tag the merge commit and push — GitHub Actions handles publish
git tag -a vx.y.z -m "Release vx.y.z"
git push origin main
git push origin vx.y.z
# GitHub Actions handles publish on tag push
```

Tags containing `-rc` (e.g. `v0.3.0-rc1`) follow the same steps but the
publish workflow will not trigger (RC tags are excluded).

## Hotfix

```bash
git checkout -b hotfix/vx.y.z+1 vx.y.z
# Apply fix, bump patch version in Cargo.toml
git commit -am "fix: description"
git tag -a vx.y.z+1 -m "Hotfix vx.y.z+1"
git push origin hotfix/vx.y.z+1 vx.y.z+1
# Merge back to main
git checkout main
git merge --no-ff hotfix/vx.y.z+1
git push origin main
```

## CHANGELOG Format

Move `[Unreleased]` entries to a versioned section:

```markdown
## [0.2.0] — 2026-MM-DD

### Added
- …

### Fixed
- …

## [Unreleased]
```