releases

Author: tonybenoy

.github/RELEASE_CHECKLIST.md

@@ -0,0 +1,119 @@
+# Release Checklist
+
+Use this checklist when preparing a manual release.
+
+## Pre-Release Checks
+
+### Code Quality
+- [ ] All tests pass locally (`uv run pytest src/tests/`)
+- [ ] Linting passes (`uv run ruff check .`)
+- [ ] Formatting is consistent (`uv run ruff format --check .`)
+- [ ] Type checking passes (`uv run mypy src/`)
+- [ ] Pre-commit hooks pass (`uv run pre-commit run --all-files`)
+
+### Documentation
+- [ ] README.md is up to date
+- [ ] CHANGELOG.md has unreleased changes documented
+- [ ] API documentation is current
+- [ ] Version-specific documentation is ready
+
+### Dependencies
+- [ ] Dependencies are up to date (`uv sync`)
+- [ ] Security vulnerabilities checked (`uv run safety check`)
+- [ ] License compliance verified
+
+### Environment Testing
+- [ ] Docker build succeeds (`docker compose build`)
+- [ ] Docker containers start successfully (`docker compose up -d`)
+- [ ] Health checks pass (`make health-check`)
+- [ ] Integration tests pass
+
+## Release Process
+
+### 1. Version Planning
+- [ ] Determine version type (major/minor/patch)
+- [ ] Review breaking changes (if major version)
+- [ ] Plan migration path (if needed)
+
+### 2. Version Bump
+Choose one method:
+
+**Automatic (recommended):**
+```bash
+make bump-patch    # or bump-minor, bump-major
+```
+
+**Manual:**
+- [ ] Update version in `pyproject.toml`
+- [ ] Update CHANGELOG.md with new version
+- [ ] Commit changes: `git commit -m "Bump version to X.Y.Z"`
+- [ ] Create tag: `git tag -a "vX.Y.Z" -m "Release X.Y.Z"`
+- [ ] Push: `git push && git push --tags`
+
+### 3. GitHub Release
+The release workflow will automatically:
+- [ ] Run complete test suite
+- [ ] Build Python packages
+- [ ] Build and push Docker images
+- [ ] Create GitHub release with notes
+- [ ] Publish to container registry
+
+### 4. Post-Release Verification
+- [ ] GitHub release created successfully
+- [ ] Docker images available (`ghcr.io/owner/repo:version`)
+- [ ] Release notes are accurate
+- [ ] Download links work
+- [ ] Documentation updated (if needed)
+
+### 5. Communication
+- [ ] Announce on relevant channels
+- [ ] Update any dependent projects
+- [ ] Close related issues/milestones
+
+## Hotfix Releases
+
+For urgent fixes to production:
+
+1. **Create hotfix branch** from latest release tag:
+   ```bash
+   git checkout -b hotfix/vX.Y.Z+1 vX.Y.Z
+   ```
+
+2. **Apply minimal fix** and test thoroughly
+
+3. **Follow release process** with patch version bump
+
+4. **Merge back** to main branch:
+   ```bash
+   git checkout main
+   git merge hotfix/vX.Y.Z+1
+   ```
+
+## Rollback Procedure
+
+If a release has critical issues:
+
+1. **Immediate action:**
+   - Mark GitHub release as pre-release
+   - Update Docker tags to point to previous version
+
+2. **Create hotfix** following procedure above
+
+3. **Communicate** the rollback and timeline for fix
+
+## Version Naming Conventions
+
+- **Stable releases**: `vX.Y.Z` (e.g., v1.2.3)
+- **Pre-releases**: `vX.Y.Z-alpha.N`, `vX.Y.Z-beta.N`, `vX.Y.Z-rc.N`
+- **Development**: Use pre-release versions
+
+## Automation
+
+This project supports automated releases via conventional commits:
+
+- `feat: description` → Minor release
+- `fix: description` → Patch release
+- `feat!: description` → Major release
+- `BREAKING CHANGE: description` → Major release
+
+**Enable automated releases** by merging commits with conventional format to main branch.

.github/release-template.md

@@ -0,0 +1,78 @@
+# Release Template
+
+This template is used for creating consistent GitHub releases.
+
+## What's Changed
+
+<!-- Auto-generated release notes will be inserted here -->
+
+## 📦 Installation
+
+### Using Git
+```bash
+git clone https://github.com/{OWNER}/{REPO}.git
+cd Web-Service-Python
+git checkout v{VERSION}
+uv sync
+```
+
+### Using Docker
+```bash
+docker pull ghcr.io/{OWNER}/{REPO}:{VERSION}
+```
+
+## 🚀 Quick Start
+
+### Development Setup
+```bash
+# Clone and setup
+git clone https://github.com/{OWNER}/{REPO}.git
+cd Web-Service-Python
+cp .env-copy .env
+
+# Install dependencies
+uv sync --dev
+
+# Start development server
+uv run uvicorn src.main:app --reload
+```
+
+### Production Deployment
+```bash
+# Clone and configure
+git clone https://github.com/{OWNER}/{REPO}.git
+cd Web-Service-Python
+cp .env-copy .env
+
+# Edit .env with your production settings
+# Then start with Docker Compose
+docker compose up -d
+```
+
+## 🧪 Testing
+
+All releases are tested with:
+- **Unit Tests**: 84+ passing tests covering core functionality
+- **Integration Tests**: End-to-end API testing
+- **Code Quality**: Linting, formatting, and type checking
+- **Docker Build**: Multi-platform container builds
+
+## 📋 Requirements
+
+- **Python**: 3.10+ (for local development)
+- **Docker**: 20.10+ & Docker Compose v2 (for containerized deployment)
+- **System**: Linux, macOS, or Windows with WSL2
+
+## 🆘 Support
+
+- **Documentation**: [README.md](README.md)
+- **Issues**: [GitHub Issues](../../issues)
+- **Discussions**: [GitHub Discussions](../../discussions)
+
+## 🔄 Migration Notes
+
+<!-- Add any breaking changes or migration steps here -->
+
+---
+
+**Full Changelog**: {COMPARE_URL}