-
Notifications
You must be signed in to change notification settings - Fork 8
Open
Labels
Description
Release Automation Implementation
Current Status
- ✅ Basic CI workflow implemented (.github/workflows/ci.yml)
- ✅ Package building and testing working
- ❌ Missing: Automated PyPI publishing and GitHub releases
Required Components
1. Release Workflow (.github/workflows/release.yml)
- Automated PyPI publishing on version tags
- GitHub release creation
- TestPyPI publishing for testing
- Release notes generation
2. PyPI Publishing Setup
- PyPI API token configuration in GitHub secrets
- TestPyPI token for testing releases
- Release workflow triggers (v* tags)
3. Version Management
- Automated version bumping process
- Changelog generation
- Release tag creation workflow
Implementation Plan
Phase 1: Basic Release Workflow
- Create release.yml workflow
- Set up PyPI publishing
- Configure GitHub release creation
Phase 2: Enhanced Features
- Automated changelog generation
- Version bumping automation
- TestPyPI publishing for testing
- Release notes templates
Setup Requirements
- PyPI API Token: Add to GitHub repository secrets
- TestPyPI Token: For testing releases
- GitHub Token: For creating releases (usually auto-configured)
Release Process
Priority
- Medium: Important for package distribution but not blocking current development
- Timing: After current PR is merged and v1.0.0 is ready for release
Dependencies
- Current PR must be merged first
- Package must be ready for v1.0.0 release
- PyPI account setup required