0a17d2c9d8
- Add ci.yml for continuous integration on every commit - Test builds on Ubuntu/macOS with Python 3.9/3.10/3.11 - Ensure code quality before any release - Add release-manual.yml for controlled releases - Manual trigger prevents accidental releases - Version validation and tag creation - Optional TestPyPI testing before production - Only creates tag after validation passes - Keep build-and-publish.yml for automated PyPI deployment - Triggered by new tags (separation of concerns) - Handles multi-platform wheel building - Allows retry if PyPI upload fails - Update RELEASE.md with clear prerequisites and workflow This setup ensures: 1. Every commit is tested (CI) 2. Releases are deliberate (manual trigger) 3. Failed CI won't create broken tags 4. PyPI publish can be retried independently
82 lines
2.0 KiB
Markdown
82 lines
2.0 KiB
Markdown
# Release Guide
|
|
|
|
## 📋 Prerequisites
|
|
|
|
Before releasing, ensure:
|
|
1. ✅ All code changes are committed and pushed
|
|
2. ✅ CI has passed on the latest commit (check [Actions](https://github.com/yichuan-w/LEANN/actions/workflows/ci.yml))
|
|
3. ✅ You have determined the new version number
|
|
|
|
## 🚀 Recommended: Manual Release Workflow
|
|
|
|
### Via GitHub UI (Most Reliable)
|
|
|
|
1. **Verify CI Status**: Check that the latest commit has a green checkmark ✅
|
|
2. Go to [Actions → Manual Release](https://github.com/yichuan-w/LEANN/actions/workflows/release-manual.yml)
|
|
3. Click "Run workflow"
|
|
4. Enter version (e.g., `0.1.1`)
|
|
5. Toggle "Test on TestPyPI first" if desired
|
|
6. Click "Run workflow"
|
|
|
|
**What happens:**
|
|
- ✅ Validates version format
|
|
- ✅ Updates all package versions
|
|
- ✅ Optionally tests on TestPyPI
|
|
- ✅ Creates tag and GitHub release
|
|
- ✅ Automatically triggers PyPI publish
|
|
|
|
### Via Command Line
|
|
|
|
```bash
|
|
gh workflow run release-manual.yml -f version=0.1.1 -f test_pypi=true
|
|
```
|
|
|
|
## ⚡ Quick Release (One-Line)
|
|
|
|
For experienced users who want the fastest path:
|
|
|
|
```bash
|
|
./scripts/release.sh 0.1.1
|
|
```
|
|
|
|
This script will:
|
|
1. Update all package versions
|
|
2. Commit and push changes
|
|
3. Create GitHub release
|
|
4. CI automatically builds and publishes to PyPI
|
|
|
|
⚠️ **Note**: If CI fails, you'll need to manually fix and re-tag
|
|
|
|
## Manual Testing Before Release
|
|
|
|
For testing specific packages locally (especially DiskANN on macOS):
|
|
|
|
```bash
|
|
# Build specific package locally
|
|
./scripts/build_and_test.sh diskann # or hnsw, core, meta, all
|
|
|
|
# Test installation in a clean environment
|
|
python -m venv test_env
|
|
source test_env/bin/activate
|
|
pip install packages/*/dist/*.whl
|
|
|
|
# Upload to Test PyPI (optional)
|
|
./scripts/upload_to_pypi.sh test
|
|
|
|
# Upload to Production PyPI (use with caution)
|
|
./scripts/upload_to_pypi.sh prod
|
|
```
|
|
|
|
## First-time setup
|
|
|
|
1. Install GitHub CLI:
|
|
```bash
|
|
brew install gh
|
|
gh auth login
|
|
```
|
|
|
|
2. Set PyPI token in GitHub:
|
|
```bash
|
|
gh secret set PYPI_API_TOKEN
|
|
# Paste your PyPI token when prompted
|
|
``` |