Skip to content

Commit 123063e

Browse files
committed
docs: add release checklist and v0.1.0 release notes
1 parent 15178ff commit 123063e

2 files changed

Lines changed: 100 additions & 0 deletions

File tree

docs/release-checklist.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Release Checklist
2+
3+
Use this checklist for every FaultLine release.
4+
5+
## 1. Pre-flight
6+
- Confirm working tree is clean: `git status --short`
7+
- Confirm current branch and target tag.
8+
- Confirm crates.io auth is valid: `cargo login --help` (or previous successful login in current session).
9+
10+
## 2. Quality Gates
11+
- Run format gate: `cargo fmt --all -- --check`
12+
- Run lint gate: `cargo clippy --workspace --all-targets -- -D warnings`
13+
- Run test gate: `cargo test --workspace`
14+
- Run compile gate: `cargo check --workspace`
15+
16+
## 3. Metadata and Docs
17+
- Verify each crate has:
18+
- `description`
19+
- `license`
20+
- `repository`
21+
- `homepage`
22+
- `documentation`
23+
- `keywords`
24+
- `categories`
25+
- `readme`
26+
- `rust-version`
27+
- Ensure crate `README.md` files exist and are current.
28+
- Ensure top-level `README.md` badges and links point to the live repository.
29+
30+
## 4. Versioning and Dependency Alignment
31+
- Bump versions in crate manifests as needed.
32+
- For internal crate dependencies, include both `version` and `path`.
33+
- Validate dependency publish order from root to leaves:
34+
1. `faultline_core`
35+
2. `faultline_geometry`
36+
3. `faultline_diff`
37+
4. `faultline_sync`
38+
5. `faultline_index`
39+
6. `faultline_compute`
40+
7. `faultline_agents`
41+
42+
## 5. Publish Verification
43+
- Dry-run first-order crates:
44+
- `cargo publish --dry-run -p faultline_core`
45+
- `cargo publish --dry-run -p faultline_geometry`
46+
- For local WIP trees, if needed use `--allow-dirty` intentionally.
47+
- Note: dependent crate dry-runs may fail until upstream crates are actually published.
48+
49+
## 6. Publish Execution
50+
- Publish in dependency order using `cargo publish -p <crate>`.
51+
- If crates.io returns `429 Too Many Requests`:
52+
- Wait until the exact retry timestamp from the error.
53+
- Retry only the failed crate.
54+
55+
## 7. Post-publish Verification
56+
- Confirm visibility on crates.io: `cargo info <crate>` from outside workspace (for example `/tmp`).
57+
- Confirm docs.rs pages are building for all crates.
58+
59+
## 8. Git and Release Artifacts
60+
- Commit final release docs/metadata updates.
61+
- Tag release: `git tag -a vX.Y.Z -m "FaultLine crates X.Y.Z release"`
62+
- Push branch and tag.
63+
- Create GitHub Release with notes and crate links.
64+
65+
## 9. Follow-up
66+
- Open next milestone issue for patch release tasks.
67+
- Capture any publish incidents in this checklist.

docs/releases/v0.1.0.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# FaultLine v0.1.0
2+
3+
Initial public crate release for the FaultLine Rust workspace.
4+
5+
## Published Crates
6+
- `faultline_core` - Canonical domain models, identifiers, and manifests.
7+
- `faultline_geometry` - Geometry abstractions and spatial metric contracts.
8+
- `faultline_diff` - Diff and change classification contracts.
9+
- `faultline_sync` - Local-first synchronization models and operation envelopes.
10+
- `faultline_index` - Spatial index abstractions.
11+
- `faultline_compute` - Execution backend abstractions.
12+
- `faultline_agents` - Planner/executor/reviewer orchestration contracts.
13+
14+
## Highlights
15+
- Established stable `0.1.0` contracts across all core workspace crates.
16+
- Added deterministic diff artifact models and baseline compare engine.
17+
- Added sync operation envelopes, causal context, and in-memory session behavior.
18+
- Added compute backend and index abstraction traits with baseline implementations.
19+
- Added agent workflow graph, tool registry, and artifact store contracts.
20+
21+
## Quality Gates
22+
Release passed:
23+
- `cargo fmt --all -- --check`
24+
- `cargo clippy --workspace --all-targets -- -D warnings`
25+
- `cargo test --workspace`
26+
- `cargo check --workspace`
27+
28+
## Repository
29+
- GitHub: https://github.com/chrislyonsKY/FaultLine
30+
- Tag: `v0.1.0`
31+
32+
## Notes
33+
This release is architecture- and contract-first, with research-heavy implementations intentionally deferred to subsequent milestones.

0 commit comments

Comments
 (0)