Release Process

June 27, 2026 · View on GitHub

This document outlines the process for releasing a new version of Bum.

Overview

Bum has two release channels:

GitHub Releases - Standalone Rust binaries (via install.sh)
npm Registry - NAPI-RS packages (via npm install)

Both are triggered automatically when you push a version tag.

Version Update Checklist

Before releasing, update the version in all of these files:

1. `Cargo.toml` (line 3)

[package]
name = "bum"
version = "0.7.0"  # Update this
edition = "2021"

2. `package.json`

Update the version in three places:

Root version field (line 3)
All optionalDependencies entries (e.g. @owenizedd/bum-linux-x64-gnu)

# Quick way: replace every occurrence in package.json
sed -i 's/"0.7.0"/"0.7.1"/g' package.json

3. `npm/*/package.json` (platform packages)

# Update every platform package under npm/
find npm -name 'package.json' -exec sed -i 's/"0.7.0"/"0.7.1"/g' {} +

4. `install.sh` (line 4)

#!/usr/bin/env bash
set -euo pipefail

VERSION="v0.7.0"  # Update this (note the 'v' prefix)

Release Steps

1. Update Version Numbers

# Manually update Cargo.toml, package.json, and install.sh
# Or use this helper:
./scripts/bump-version.sh 0.7.0

2. Update `Cargo.lock`

cargo build --release

3. Commit Changes

git add Cargo.toml Cargo.lock package.json install.sh
git commit -m "Bump version to 0.7.0"
git push origin main

4. Create and Push Tag

# Create the tag
git tag v0.7.0

# Push the tag to trigger releases
git push origin v0.7.0

What Happens Automatically

When you push a tag (e.g., v0.7.0), two workflows are triggered:

1. `deploy.yml` - GitHub Releases

Builds standalone binaries for:

macOS (Intel + ARM64)
Linux (x64 + ARM64, glibc + musl)
Windows (x64)

These are uploaded to GitHub Releases and used by install.sh.

2. `ci.yml` - npm Publish

Builds NAPI-RS packages for:

All platforms above
Universal macOS binary (Intel + ARM64 combined)

These are published to npm registry as @owenizedd/bum.

Monitoring Release

Check GitHub Actions

Go to Actions tab
Look for two workflow runs:
- Deploy (GitHub Releases)
- CI (npm publish)
Ensure all jobs pass ✅

Verify GitHub Release

Go to Releases
Verify assets are uploaded (.tar.gz and .zip files)

Verify npm Package

# Check if published
npm view @owenizedd/bum

# Test installation
npx @owenizedd/bum@0.7.0 --version

Verify install.sh

# Test installation script
curl -fsSL https://github.com/owenizedd/bum/raw/main/install.sh | bash
bum --version

Version Numbering

We follow Semantic Versioning:

MAJOR (1.0.0) - Breaking changes
MINOR (0.7.0) - New features (backward compatible)
PATCH (0.7.1) - Bug fixes

Examples

# Bug fix
0.6.1 → 0.6.2

# New feature
0.6.1 → 0.7.0

# Breaking change
0.6.1 → 1.0.0

Troubleshooting

Tag Already Exists

If you need to recreate a tag:

# Delete local tag
git tag -d v0.7.0

# Delete remote tag
git push origin :refs/tags/v0.7.0

# Create new tag
git tag v0.7.0

# Push new tag
git push origin v0.7.0

Workflow Failed

Check the workflow logs in GitHub Actions
Fix the issue
Commit the fix
Delete and recreate the tag (see above)

npm Publish Failed

Common issues:

NPM_TOKEN expired - Update in GitHub Secrets
Version already published - Bump to next version
Publish check failed - Ensure tag format is v0.7.0

Post-Release

After a successful release:

Announce on social media / community channels
Update documentation if needed
Close related issues/PRs
Monitor for issues from users

Release Checklist

Use this checklist for each release: