git-vdb 0.4.0

An embedded vector database backed by immutable Git trees
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

# Releasing git-vdb

Crates.io releases are permanent. A version cannot be overwritten or deleted;
it can only be yanked. Publish only from a reviewed, clean `main` commit whose
package contents and generated documentation have been inspected.

## Prepare

1. Update `Cargo.toml` and `CHANGELOG.md` to the same Semantic Version.
2. Keep persisted format-version changes separate and update the applicable
   normative specification under `docs/` only after compatibility and migration
   policy has been approved.
3. Run the complete release gates:

   ```sh
   nix flake check --print-build-logs
   cargo test --all-targets --all-features --locked
   cargo clippy --all-targets --all-features --locked -- -D warnings
   RUSTDOCFLAGS='-D warnings' cargo doc --no-deps --all-features --locked
   cargo +1.97.1 check --lib --locked
   cargo +1.97.1 test --doc --locked
   cargo package --list
   cargo publish --dry-run --locked
   ```

4. Inspect `target/package/git-vdb-VERSION.crate` and verify that it contains
   only the intended library, CLI, public examples/tests, specifications, and
   project metadata.
5. Push the release commit and wait for CI on `main` to pass.

## Publish

Authenticate with a scoped crates.io token using `cargo login`, then publish:

```sh
cargo publish --locked
```

Confirm that the crate page and docs.rs build are healthy before tagging. Then
create and push an annotated tag matching the crate version:

```sh
git tag -a vVERSION -m "git-vdb VERSION"
git push origin vVERSION
```

The tag workflow creates a GitHub release and uploads native Linux, macOS, and
Windows CLI archives with SHA-256 checksum files. Verify the release artifacts,
installation with `cargo install git-vdb --version VERSION`, and the versioned
docs.rs URL.