Skip to content

RELEASE.md

Latest commit

 

History

History
164 lines (130 loc) · 4.06 KB

RELEASE.md

File metadata and controls

164 lines (130 loc) · 4.06 KB
Raw

Release Checklist for v0.9.3

Pre-Release Verification

✅ Code Complete

  • PHASE 1: Architecture consolidation
  • PHASE 2: GitHub Action (standalone + cloud modes)
  • PHASE 3: CLI hardening (--ci flag, --offline demo, improved diagnose)
  • PHASE 4: Langfuse + LangSmith connectors
  • PHASE 5: Weight learner with progressive blending
  • PHASE 6: Package verification (demo, MCP, verify_install.sh)
  • PHASE 7: Documentation (README, CHANGELOG, Action README)
  • PHASE 8: Telemetry (DEFERRED with TODO)
  • PHASE 9: Data contribution (DEFERRED with TODO)
  • PHASE 10: Release hygiene (pyproject.toml, classifiers, keywords)

✅ Tests Passing

pytest tests/ -v
# Expected: 279+ tests passing

✅ GitHub Action Tests

cd github-action/src && python test_run.py
# Expected: All 11 tests passed

✅ Installation Verification

pip install -e .
driftbase --version
driftbase demo --offline
# Expected: Demo generates 20 runs successfully

✅ Package Build

python -m build
# Expected: Successfully built .tar.gz and .whl

✅ Documentation

  • README.md updated with GitHub Action, demo, LangSmith support
  • CHANGELOG.md created with full release notes
  • github-action/README.md comprehensive (282 lines)
  • pyproject.toml has keywords, classifiers, updated URLs

Release Steps

1. Clean Working Directory

git status
# Should be clean or only include intended changes

2. Commit Final Changes

git add .
git commit -m "Release v0.9.3: GitHub Action, LangSmith connector, progressive weight learning"

3. Create Git Tag

git tag -a v0.9.3 -m "Release v0.9.3

- GitHub Action for automated drift checks in CI/CD
- LangSmith connector with full Cloud parity
- Progressive weight learning (30% → 70% blending)
- CLI enhancements (--ci, --offline, improved diagnose)
- Comprehensive documentation and tests

See CHANGELOG.md for full details."

4. Verify Version

python -m build
# Should now build as driftbase-0.9.3.tar.gz (no .dev suffix)

5. Push to GitHub

git push origin main
git push origin v0.9.3

6. Publish to PyPI

# Build clean distributions
rm -rf dist/ build/
python -m build

# Upload to PyPI (requires PyPI credentials)
python -m twine upload dist/*

7. Verify PyPI Package

# Wait 2-3 minutes for PyPI to process
pip install --upgrade driftbase
driftbase --version
# Should show: driftbase, version 0.9.3

8. Test GitHub Action

Create a test repository with .github/workflows/drift-check.yml:

- uses: driftbase-labs/driftbase-python/github-action@v0.9.3

Verify it installs driftbase 0.9.3 from PyPI.

Post-Release

Update Documentation Sites

Announce Release

  • GitHub release notes (auto-generated from tag)
  • Discord announcement
  • Twitter/X post

Rollback Plan

If critical issues are found:

  1. Yank the PyPI release:

    pip install twine
twine upload --repository pypi --skip-existing dist/*
# Then use PyPI web interface to yank version

  2. Create hotfix tag:

    git tag -d v0.9.3
git push origin :refs/tags/v0.9.3
# Fix issues
git tag v0.9.3.1
git push origin v0.9.3.1

Version Numbering

  • Current: 0.9.3 (pre-1.0 release)
  • Next planned: 0.9.4 (after Cloud API is deployed with Phases 8+9)
  • Stable 1.0: After production validation and Cloud integration

Known Limitations

Document in release notes:

  1. Telemetry disabled - Deferred until Cloud API is live (Phase 8)
  2. Data contribution disabled - Deferred until Cloud API is live (Phase 9)
  3. Cloud mode in GitHub Action - Requires DRIFTBASE_API_KEY (not yet available publicly)
  4. Minimum data requirement - Need 50+ runs per version for TIER3 confidence

Support Channels