vmaf-head-sys 0.1.0

FFI bindings to Netflix VMAF (vendored)
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

# Release Process

This document describes how to release `vmaf-head-sys`.

## Pre-release Checklist

1. Update the version in `Cargo.toml`.
2. Update the vendored VMAF snapshot with `python vendor_vmaf.py`.
3. Run the local checks:

   ```bash
   cargo test --all-features
   cargo clippy --all-targets --all-features -- -D warnings
   cargo publish --dry-run
   ```

## Creating a Release

Commit and push the version changes, then create an annotated tag matching the Cargo version:

```bash
git tag -a v0.1.0 -m "Release v0.1.0"
git push origin v0.1.0
```

The release workflow validates the tag against `Cargo.toml` and creates the GitHub release.

After the workflow succeeds, publish the crate:

```bash
cargo publish
```

## Versioning

This project follows semantic versioning. Because the crate tracks VMAF HEAD, any upstream public C API change that alters generated Rust bindings may require a breaking crate release.

## Troubleshooting

If crates.io rejects the package size, inspect its contents and compressed size:

```bash
cargo package --list
ls -lh target/package/vmaf-head-sys-*.crate
```

Only the source required to compile libvmaf should be vendored. Python tooling, test resources, and upstream workspace files are intentionally omitted.