Publishing a clean source release
Public releases must contain only reusable code, examples, and documentation. Keep controller configuration, SSH keys, instance archives, journals, and private reports outside the repository.
Release assets and image publishing
Release main through the native images workflow with a semantic release_tag, such as v0.7.0. The tag must match both Python and npm versions. Clean upstream Debian bases provide the images.
The workflow builds and inspects Python and npm packages, tests their installed executables outside the checkout, and publishes @microck/raft using the repository's NPM_TOKEN secret with npm provenance. Only then does it create the GitHub release with the wheel, source archive, npm tarball and verified image assets. Published versions are immutable; after partial publication, fix the failure and use a new patch version.
gh workflow run images.yml --ref main -f release_tag=v0.7.0- Validation gating: Publication requires native lifecycle and full-image recovery jobs alongside fresh AMD64 KVM provisioning and reboot verification.
- Asset immutability: The workflow refuses existing tags and never overwrites release assets.
- Provenance records: Release assets include
SHA256SUMS, architecture manifests, package inventories, and boot reports. Manifests identify the source commit, CI run, and Incus image fingerprint. - Voxl source and licensing: Voxl's source is MIT licensed, but its x264-linked executable is distributed under GPL-2.0. Each image includes
/opt/raft/voxl-GPL-2,voxl-LICENSE,voxl-NOTICE, andvoxl-source.tar.gz. The source archive contains the pinned Voxl source, locked vendored Rust dependencies, exact Debian sources and patches for its native libraries, build instructions, architecture, and installed package versions. The image inspector requires non-empty notices and checks the source bundle's build inputs, locked dependency manifests, and Debian source archive members before emitting a release manifest. Releases publishvoxl-source-ARCH.tar.gz, license/notice files, and the Voxl version inventory beside each native image, covered bySHA256SUMS. Source ships with the binary rather than through a written offer.
Repository history hygiene
Scan all Git history, branches, and tags before changing repository visibility. A clean working tree does not remove sensitive data from commit history.
- Manual audit: Secret scanners do not catch every identifier. Inspect old commits for host addresses, usernames, local paths, and private reports.
- Fresh repository snapshot: If commit history contains sensitive data, publish a clean snapshot in a fresh public repository. History rewrites can leave orphaned commits accessible in GitHub cache (see GitHub guidance on removing sensitive data).
- Keep source private: Do not make an existing private repository public merely because its current working tree is clean.
Release verification commands
Install gitleaks, uv, Node.js with npm, and the OpenSSH client providing ssh-keygen before running these checks. Ensure they are available on PATH; uv sync --locked does not install these tools.
Run security scanning, linting, formatting checks, and package builds before tagging:
gitleaks dir --redact --no-banner .
gitleaks git --redact --no-banner .
uv sync --locked
uvx ruff check raft.py raft_files.py raft_run.py deploy/*.py
uvx ruff format --check raft.py raft_files.py raft_run.py deploy/*.py
uv run python -m compileall -q raft.py raft_files.py raft_run.py deploy
uv run python deploy/verify-limits.py
uv run python deploy/verify-image-tests.py
uv run python deploy/verify-run.py
uv run python deploy/verify-features.py
uv run python deploy/verify-self-update.py
uv build
uv run python deploy/verify-release.pyImage distribution rules
Do not upload local workspace backups or development exports as release assets. Distributable images must be built from clean upstream bases, inspected for credentials, and accompanied by fingerprints, manifests, and licenses.
Review the package contents and capability table before release. State container isolation accurately without claiming VM isolation or exact Boat compatibility. Raft is an independent alternative to boat.dev and is not affiliated with that service.