Skip to content

Crates.io release workflow

Zeeshan Lakhani edited this page Apr 30, 2020 · 10 revisions

When releasing to crates.io:

  • Remove path dependencies
  • (Possible) Updates:
    • html_root_url in core/lib.rs
    • Check Cargo.toml versions and documentation urls.
    • README.md (including version information)
    • Check lib.rs/ffi crate info for DPDK versions, as well as versions ok'ed for Rust, rr.
    • Update CHANGELOG.md when necessary
    • Create/upload git tag for reach release
    • cp .../out/bindings.rs to ffi/src/bindings_rustdoc.rs
    • Check release against sandbox-container Rust/DPDK/rr versions
    • Update examples and bench Cargos w/ core versions on minor/major versions
    • Review deps versions via cargo-outdated and cargo-udeps for unused ones
  • Docs
    • run docs for core (and ffi) via:
      cargo +nightly doc --lib --no-deps --features capsule-ffi/rustdoc,full
    • think about preview release to ensure docs.rs/crate.io 👍
Clone this wiki locally