Skip to content

RELEASE_PROCESS.md

Latest commit

 

History

History
74 lines (56 loc) · 2.13 KB

RELEASE_PROCESS.md

File metadata and controls

74 lines (56 loc) · 2.13 KB
Raw

Release Process

This document explains the automated release process for faff-core.

Dev Builds (Automatic)

Every push to main that passes CI automatically publishes a dev build to PyPI.

Versioning:

  • Base version in Cargo.toml: 0.1.0
  • Published dev versions: 0.1.0.dev1, 0.1.0.dev2, 0.1.0.dev3, etc.
  • Dev number increments with each build using GitHub Actions run number

Installation:

# Get latest dev build
pip install --pre faff-core

# Or specific dev version
pip install faff-core==0.1.0.dev5

What happens:

  1. Push to main
  2. CI workflow runs (tests, formatting, clippy)
  3. If CI passes → Publish Dev Build workflow triggers
  4. Builds wheels for all platforms (Linux, macOS x86/ARM, Windows)
  5. Publishes to PyPI with dev version number

Stable Releases (Manual)

When you're ready to release a stable version, tag the version number that is currently in Cargo.toml — that is always the correct next release version:

# Check the version
grep '^version' Cargo.toml

# Tag and push
git tag v$(grep '^version' Cargo.toml | sed 's/version = "\(.*\)"/\1/')
git push origin --tags

What happens:

  1. Release workflow triggers on tag
  2. Extracts version from tag (strips v prefix)
  3. Updates Cargo.toml with release version 0.1.0
  4. Commits version update to main
  5. Builds wheels for all platforms
  6. Publishes to PyPI (no .dev suffix)
  7. Builds WASM package via wasm-pack and publishes to npm
  8. Creates GitHub Release with artifacts
  9. Bumps Cargo.toml to next patch version 0.1.1 for future dev builds

Installation:

# Get latest stable release (no --pre flag needed)
pip install faff-core

# Or specific version
pip install faff-core==0.1.0

Requirements

The following GitHub secrets must be set:

  • PYPI_API_TOKEN: PyPI API token with permission to publish faff-core
  • NPM_TOKEN: npm access token with permission to publish the WASM package

Notes

  • Dev builds are hidden from normal pip install (need --pre flag)
  • Stable releases are what users get by default
  • All builds are published to real PyPI (not TestPyPI)
  • Version numbers follow PEP 440