Files

Cameron 002fa48b2a docs: add releasing guide (#177 )

Documents the automated release workflow:
- How to tag and push releases
- Pre-release detection (alpha/beta/rc)
- Versioning strategy (semver)
- Release checklist
- Links to npm publish tracking issue (#174)

Written by Cameron ◯ Letta Code

"Ship it." - GitHub

2026-02-05 15:13:19 -08:00

1.9 KiB

Raw Blame History

Releasing

LettaBot uses GitHub Releases with automated release notes.

How to Release

1. Tag the commit

git checkout main
git pull origin main
git tag v0.2.0
git push origin v0.2.0

2. What happens automatically

The release workflow runs on every v* tag push:

Build gate - npm ci && npm run build
Test gate - npm run test:run (all unit tests must pass)
Release notes - Auto-generated from merged PRs since the last tag
GitHub Release - Created with the notes, linked to the tag

3. Pre-releases

Tags containing alpha, beta, or rc are automatically marked as pre-release:

git tag v0.2.0-alpha.1    # marked as pre-release
git tag v0.2.0-beta.2     # marked as pre-release
git tag v0.2.0-rc.1       # marked as pre-release
git tag v0.2.0            # marked as stable release

Versioning

We follow Semantic Versioning:

Major (v1.0.0) - Breaking changes to config format, channel API, or CLI
Minor (v0.2.0) - New features, new channels, new config options
Patch (v0.1.1) - Bug fixes, dependency updates, docs

While in 0.x, minor versions may include breaking changes.

Release Checklist

Before tagging a release:

All PRs for this release are merged to main
npm run build passes locally
npm run test:run passes locally
README and docs are up to date
No known critical bugs (check open issues)

npm Publishing

Not yet available. Tracked in #174.

Currently, users install from source:

git clone https://github.com/letta-ai/lettabot.git
cd lettabot
git checkout v0.2.0  # or latest tag
npm install && npm run build && npm link

1.9 KiB Raw Blame History