Skip to content

RELEASE_CHECKLIST.md

Latest commit

 

History

History
160 lines (126 loc) · 3.86 KB

RELEASE_CHECKLIST.md

File metadata and controls

160 lines (126 loc) · 3.86 KB
Raw

Release Checklist - Version 2.0.0

Pre-Release Verification

Code Quality

  • All 58 unit tests passing
  • Test coverage at 74% (exceeds 65% requirement)
  • No failing tests
  • Code formatted with black
  • Type hints verified

Version Updates

  • pyproject.toml version updated to 2.0.0
  • ukfuelfinder/__init__.py version updated to 2.0.0
  • CHANGELOG.md updated with 2.0.0 entry
  • Release notes created (RELEASE_NOTES_2.0.0.md)

Documentation

  • README.md updated with API changes
  • Migration guide included
  • All code examples updated
  • New examples created:
    • examples/api_migration.py
    • examples/global_config.py
  • CHANGELOG.md comprehensive

Testing

  • Unit tests: 58 passing
  • HTTP client tests: 10 tests
  • Global config tests: 6 tests
  • Integration test for 404 handling added
  • Backward compatibility tested
  • Error handling tested

Features Implemented

  • Global configuration support
  • Environment variable support
  • Backward compatibility mode
  • BatchNotFoundError exception
  • Enhanced HTTP client
  • Priority-based configuration

Release Steps

1. Final Verification

# Run all tests
python3 -m pytest tests/unit/ -v

# Check coverage
python3 -m pytest tests/unit/ --cov=ukfuelfinder --cov-report=term-missing

# Verify version
python3 -c "import ukfuelfinder; print(ukfuelfinder.__version__)"

2. Git Operations

# Stage all changes
git add -A

# Commit
git commit -m "Release: Version 2.0.0 - API Changes Feb 2025

- Implement global configuration for backward compatibility
- Add comprehensive HTTP client tests
- Update all examples for new API format
- Add integration test for invalid batch 404 handling
- Update version to 2.0.0
- Create release notes and update CHANGELOG

All 58 tests passing with 74% coverage."

# Tag release
git tag -a v2.0.0 -m "Version 2.0.0 - API Changes February 2025"

# Push
git push origin main
git push origin v2.0.0

3. Build Package

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

# Build
python3 -m build

# Verify build
ls -lh dist/

4. Test Package

# Install in test environment
pip install dist/ukfuelfinder-2.0.0-py3-none-any.whl

# Test import
python3 -c "import ukfuelfinder; print(ukfuelfinder.__version__)"

# Run quick test
python3 -c "from ukfuelfinder import set_global_backward_compatible; print('OK')"

5. Publish to PyPI

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

# Test install from Test PyPI
pip install --index-url https://test.pypi.org/simple/ ukfuelfinder

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

6. GitHub Release

7. Post-Release

  • Verify PyPI page updated
  • Test installation: pip install ukfuelfinder
  • Verify documentation renders correctly
  • Update any external documentation
  • Announce release (if applicable)

Rollback Plan

If issues are discovered:

  1. Remove PyPI release (if possible)
  2. Revert git tag: git tag -d v2.0.0 && git push origin :refs/tags/v2.0.0
  3. Revert commit: git revert HEAD
  4. Fix issues
  5. Re-release as 2.0.1

Success Criteria

  • All tests pass
  • Version numbers consistent
  • Documentation complete
  • Backward compatibility maintained
  • New features working
  • Package published to PyPI
  • GitHub release created
  • Installation verified

Notes

  • This is a major version bump (2.0.0) due to API changes
  • Backward compatibility is maintained by default
  • Deprecation timeline: 6 months (until August 2025)
  • Next breaking change: Version 3.0.0 (remove backward compatibility)