Release Process

Merge dev to main and publish release.


Release Schedule

Releases: Monday, Wednesday, Friday at 9am PST


Prerequisites

Before release:

  1. All PRs merged to dev branch
  2. All features tested
  3. Documentation updated on GitHub (CHANGELOG, README, ROADMAP, API docs)
  4. No blockers or critical bugs

Release Steps

1. Version Bump

Update version in massgen/__init__.py:

__version__ = "0.1.9"

2. Final Testing

Test dev branch:

  • Run full test suite
  • Test key features
  • Verify documentation accuracy

3. Merge dev to main

git checkout main
git merge dev/vX.X.X
git push origin main

4. Create Git Tag

git tag v0.1.9
git push origin v0.1.9

5. Create GitHub Release

On GitHub:

  1. Go to Releases
  2. Click “Draft a new release”
  3. Select tag (v0.1.9)
  4. Release title: “v0.1.9”
  5. Copy content from CHANGELOG.md
  6. Publish release

Release Notes Format

## What's New in v0.x.x

### Feature A: Description

### Feature B: Description

### Getting Started
- Include link to video demo or case study (if available)
- Provide example `.yaml` configuration files for quick start
- List relevant documentation guide

## What's Changed
- List all merged PRs with format: `type: description by @username in #PR`
- Include types: feat, fix, docs, refactor, test, chore
- Link to PR numbers for full details
- Credit all contributors with @ mentions
**Full Changelog:** v0.1.8...v0.1.9

After Release

  1. Release is live on GitHub
  2. Main branch updated
  3. Next step: See Announcements to share with community
  4. Start next development cycle

Who Does This

Maintainers perform releases.

Release schedule: Regular cadence (Mon/Wed/Fri) ensures predictable releases.


Tracking Releases


Next Step

After release, see Announcements for sharing with community.


Contact

Nick Crispino

  • Discord: nickcrispino

Henry

  • Discord: henry_weiqi


Back to top

Copyright © 2025 MassGen Team. MIT License.