Skip to content

RELEASING.md

Latest commit

 

History

History
105 lines (74 loc) · 2.55 KB

RELEASING.md

File metadata and controls

105 lines (74 loc) · 2.55 KB

Releasing rustfava

This document describes the release process for rustfava.

Overview

A release involves:

  1. Creating a git tag
  2. Automated builds (desktop apps, PyPI, Docker)
  3. Publishing the release
  4. Updating Nix flake sources

Step-by-Step Process

1. Create and push a version tag

git checkout main
git pull
git tag v0.1.x
git push origin v0.1.x

2. Wait for CI workflows

The tag triggers several workflows:

Workflow Purpose Duration
desktop-release.yml Builds desktop apps for all platforms ~10 min
build-publish.yml Builds and publishes to PyPI, Docker, COPR ~60 min

Monitor at: https://github.com/rustledger/rustfava/actions

3. Approve PyPI deployment

The PyPI environment requires manual approval:

  • Go to the running build-publish.yml workflow
  • Click "Review deployments"
  • Approve the pypi environment

4. Publish the GitHub release

Once desktop-release.yml completes, it creates a draft release with:

  • .AppImage (Linux)
  • .deb, .rpm (Linux packages)
  • .dmg (macOS)
  • .msi, .exe (Windows)
  • .tar.gz (Linux tarball for Nix)

Publish it:

gh release edit v0.1.x --draft=false

Or via GitHub UI: https://github.com/rustledger/rustfava/releases

5. Update Nix flake sources

Publishing the release triggers update-flake-sources.yml, which:

  1. Downloads release tarballs
  2. Computes SRI hashes
  3. Creates a PR updating desktop-sources.json

Merge the PR when it passes CI.

6. Verify

Test the release:

# Desktop app via Nix
nix run github:rustledger/rustfava#desktop --refresh

# CLI via Nix
nix run github:rustledger/rustfava --refresh

# CLI via PyPI
uv tool install rustfava --upgrade

# Docker
docker pull ghcr.io/rustledger/rustfava:v0.1.x

Release Artifacts

Artifact Source Distribution
Desktop apps desktop-release.yml GitHub Releases
Python package build-publish.yml PyPI
Docker image build-publish.yml GHCR
Nix flake flake.nix + desktop-sources.json GitHub

Troubleshooting

Draft release not created

Check that desktop-release.yml completed successfully. The release job only runs on tags.

Nix flake sources not updated

The update-flake-sources.yml workflow only triggers on release: published events. Make sure the release is not still in draft.

PyPI publish failed

Check the workflow logs. Common issues:

  • Version already exists on PyPI (can't overwrite)
  • Missing approval for the pypi environment