Skip to content

distribution.md

Latest commit

 

History

History
67 lines (51 loc) · 3.47 KB

distribution.md

File metadata and controls

67 lines (51 loc) · 3.47 KB

Distribution (v0)

This document defines what users get from each install channel, supported platforms, and the stable on-disk SDK layout.

Support Tiers

A platform/channel combination is official only when all of these are true:

  • Users can install via an idiomatic channel command (e.g. brew install, npm i -g, uv tool install) without building from source.
  • The install path is exercised by automated smoke checks in CI/release workflows.
  • The combination is explicitly marked official in the install matrix.

A combination can be preview when install metadata/artifacts are wired and at least one release-time smoke gate exists, but full target-matrix coverage is not yet complete.

Official platforms:

  • macOS: aarch64-apple-darwin, x86_64-apple-darwin
  • Linux: x86_64-unknown-linux-gnu
  • Windows: x86_64-pc-windows-msvc via npm and PyPI release artifacts

Not currently targeted:

  • aarch64-unknown-linux-gnu
  • Linux distro packages (apt, yum, pacman, etc.)

Install Matrix

Channel Install Command Provides CLI Provides Library Tier Notes
Homebrew (macOS and Linux) brew install sandover/tap/plasmite Yes Yes (system SDK) official Installs bin/, lib/, include/, pkg-config metadata.
crates.io (Rust) cargo install plasmite Yes No official Installs binaries into Cargo bin dir; source build.
crates.io (Rust) cargo add plasmite No Yes (Rust crate) official Standard Rust dependency.
PyPI (Python) uv tool install plasmite Yes Yes (Python bindings) official (macOS/Windows x86_64) Wheel bundles native assets and CLI where wheels are published; Linux currently falls back to source distribution.
npm (Node) npm i -g plasmite Yes Yes (Node bindings) official (macOS/Linux/Windows x86_64) Bundles addon, native assets, and CLI.
Go module go get github.com/sandover/plasmite/bindings/go/local No Yes (Go bindings) official (macOS/Linux) Requires system SDK (brew/manual) for cgo; import pure contracts from /api when needed.
GitHub release tarball Download from releases Yes Yes (SDK layout) official (manual path) Contains bin/, lib/, include/, lib/pkgconfig/.
cargo-binstall (Rust binary installer) cargo binstall plasmite --no-confirm Yes No preview (x86_64-unknown-linux-gnu, x86_64-apple-darwin, aarch64-apple-darwin) Uses package.metadata.binstall URL mapping to GitHub release SDK tarballs; release-publish smoke gate is currently Linux-only.

cargo-binstall Promotion Criteria

Current tier is preview.

Promotion to official requires all of:

  • Fail-closed release automation smoke coverage for every intended official target triple (not only Linux).
  • Post-release delivery verification evidence for the same target set.
  • Tier update in this document and corresponding release policy updates in docs/record/releasing.md.

SDK Layout (Release Artifacts)

GitHub release tarballs are the single source of truth for the SDK layout:

bin/
  plasmite
  pls
include/
  plasmite.h
lib/
  libplasmite.(dylib|so)
  pkgconfig/
    plasmite.pc

pkg-config Contract

The plasmite.pc file must:

  • Be named plasmite (not libplasmite)
  • Provide Cflags: -I... for include/plasmite.h
  • Provide Libs: -L... -lplasmite
  • For Linux SDK artifacts, provide Libs.private: -lpthread -ldl -lm so pkg-config --static --libs plasmite resolves required system libraries.