Skip to content

PUBLISHING.md

Latest commit

 

History

History
136 lines (105 loc) · 3.19 KB

PUBLISHING.md

File metadata and controls

136 lines (105 loc) · 3.19 KB
Raw

Publishing Guide

This document outlines the steps to publish DotState to various package managers and platforms.

Pre-Release Checklist

  • Update version in Cargo.toml
  • Update CHANGELOG.md with release notes
  • Update README.md if needed
  • Run full test suite: cargo test
  • Run clippy: cargo clippy -- -D warnings
  • Check formatting: cargo fmt -- --check
  • Build release: cargo build --release
  • Test release binary locally
  • Create git tag: git tag -a v0.1.0 -m "Release v0.1.0"
  • Push tag: git push origin v0.1.0

Publishing to crates.io

  1. Create account on crates.io
  2. Get API token from account settings
  3. Login: 
    cargo login YOUR_API_TOKEN
  4. Publish: 
    cargo publish

Note: Publishing to crates.io is permanent. Make sure everything is correct!

Publishing to Homebrew

Initial Setup

  1. Fork homebrew-core (or create your own tap)
  2. Create formula in Formula/dotstate.rb
  3. Calculate SHA256: 
    # After creating a release on GitHub
wget https://github.com/serkanyersen/dotstate/archive/v0.1.0.tar.gz
shasum -a 256 v0.1.0.tar.gz
  4. Update formula with the SHA256
  5. Test locally: 
    brew install --build-from-source Formula/dotstate.rb
  6. Submit PR to homebrew-core (or merge to your tap)

Creating Your Own Tap

  1. Create repository homebrew-dotstate on GitHub

  2. Add formula to the repository

  3. Users install with:

    brew tap serkanyersen/dotstate
brew install dotstate

    Or use the direct install:

    brew install serkanyersen/dotstate/dotstate

GitHub Releases

  1. Create release on GitHub:
    • Go to Releases → Draft a new release
    • Tag: v0.1.0
    • Title: v0.1.0
    • Description: Copy from CHANGELOG.md
  2. Upload binaries (optional, for direct downloads):
    • Build for multiple platforms
    • Upload .tar.gz or .zip files
  3. Publish release

Building Binaries for Distribution

macOS

# Build for Apple Silicon
cargo build --release --target aarch64-apple-darwin

# Build for Intel
cargo build --release --target x86_64-apple-darwin

Linux

# Build for x86_64
cargo build --release --target x86_64-unknown-linux-gnu

# Or use Docker for consistent builds
docker run --rm -v $(pwd):/app -w /app rust:latest cargo build --release

Cross-compilation

Install cross-compilation targets:

rustup target add aarch64-apple-darwin
rustup target add x86_64-unknown-linux-gnu

Version Bumping

When releasing a new version:

  1. Update Cargo.toml:

    version = "0.1.1"

  2. Update CHANGELOG.md:

    • Move items from [Unreleased] to new version section
    • Add release date

  3. Commit and tag:

    git add Cargo.toml CHANGELOG.md
git commit -m "Bump version to 0.1.1"
git tag -a v0.1.1 -m "Release v0.1.1"
git push origin main --tags

Post-Release

  • Announce on social media (if desired)
  • Update documentation if needed
  • Monitor issues and feedback
  • Plan next release