Skip to content

RELEASE_CHECKLIST.md

Latest commit

 

History

History
132 lines (104 loc) · 3.01 KB

RELEASE_CHECKLIST.md

File metadata and controls

132 lines (104 loc) · 3.01 KB

Release Checklist for v0.6.0

Pre-Release Verification

✅ Code Quality

  • Version updated to 0.6.0 in pyproject.toml
  • CHANGELOG.md created with all changes documented
  • All examples tested and working
  • No syntax errors in any files
  • Import statements verified

✅ Documentation

  • README.md enhanced with provider showcase
  • PARAMETERS.md created with complete reference
  • GETTING_STARTED.md available
  • API_REFERENCE.md available
  • DEVELOPER_GUIDE.md available
  • All provider READMEs created (STT, LLM, TTS)

✅ Examples

  • 8 STT provider examples
  • 13 LLM provider examples
  • 17 TTS provider examples
  • 2 combined stack examples
  • Basic example with full parameter documentation
  • MCP sales example
  • Murf.ai example

✅ Package Metadata

  • PyPI classifiers added
  • Keywords expanded for better discoverability
  • License file included
  • README.md set as long description

Build & Test

Local Testing

# Clean previous builds
rm -rf dist/ build/ *.egg-info

# Build the package
python -m build

# Test installation locally
pip install dist/piopiy_ai-0.6.0-py3-none-any.whl

# Verify imports
python -c "from piopiy.agent import Agent; print('✅ Import successful')"

# Run basic example
python example/basic/basic.py

Test PyPI (Optional)

# Upload to Test PyPI first
python -m twine upload --repository testpypi dist/*

# Test installation from Test PyPI
pip install --index-url https://test.pypi.org/simple/ piopiy-ai==0.6.0

Release to PyPI

Build Package

# Ensure build tools are installed
pip install --upgrade build twine

# Build distribution packages
python -m build

Upload to PyPI

# Upload to PyPI
python -m twine upload dist/*

# You'll be prompted for:
# - Username: __token__
# - Password: <your-pypi-token>

Verify Release

# Wait a few minutes, then install from PyPI
pip install piopiy-ai==0.6.0

# Verify installation
python -c "from piopiy.agent import Agent; print('✅ PyPI release successful')"

Post-Release

Git Tagging

# Create and push git tag
git tag -a v0.6.0 -m "Release v0.6.0 - 40+ provider examples"
git push origin v0.6.0

GitHub Release

  1. Go to https://github.com/telecmi/agents/releases
  2. Click "Draft a new release"
  3. Select tag: v0.6.0
  4. Title: "v0.6.0 - Comprehensive Provider Examples"
  5. Copy content from CHANGELOG.md
  6. Publish release

Announce

  • Update documentation website (if applicable)
  • Post on social media/blog
  • Notify users of new features

Rollback Plan

If issues are discovered:

# Yank the release from PyPI (doesn't delete, just hides)
pip install --upgrade twine
twine upload --repository pypi --skip-existing dist/*
# Then use PyPI web interface to yank the version

Notes

  • Version: 0.6.0
  • Release Date: 2026-02-12
  • Major Changes: 40+ provider examples, comprehensive documentation
  • Breaking Changes: None
  • Migration Guide: Not needed