|
| 1 | +# 2.2.0 Release Checklist |
| 2 | + |
| 3 | +This checklist is intended for the `2.2.0` release on top of the stable 2.x |
| 4 | +line. |
| 5 | + |
| 6 | +## Purpose |
| 7 | + |
| 8 | +- publish the next stable 2.x refinement release of ExcelAlchemy |
| 9 | +- present `2.2.0` as a runtime-consolidation and developer-ergonomics release |
| 10 | +- keep the public 2.x workflow stable while making the internal import runtime |
| 11 | + more explicit |
| 12 | +- reinforce `storage=...` as the recommended backend integration path |
| 13 | + |
| 14 | +## Release Positioning |
| 15 | + |
| 16 | +`2.2.0` should be presented as an architectural refinement release: |
| 17 | + |
| 18 | +- the public import and export workflow API stays stable |
| 19 | +- import runs now expose a clearer lifecycle through `ImportSession` |
| 20 | +- config construction is easier to read through dedicated helper constructors |
| 21 | +- storage integration becomes more clearly protocol-first without breaking 2.x |
| 22 | + compatibility |
| 23 | + |
| 24 | +## Before Tagging |
| 25 | + |
| 26 | +1. Confirm the intended version in `src/excelalchemy/__init__.py`. |
| 27 | +2. Review the `2.2.0` section in `CHANGELOG.md`. |
| 28 | +3. Confirm `README.md`, `README-pypi.md`, and `MIGRATIONS.md` still describe |
| 29 | + the recommended public paths correctly. |
| 30 | +4. Confirm `README_cn.md` remains aligned with the current release position. |
| 31 | +5. Confirm the compatibility notes for: |
| 32 | + - `minio / bucket_name / url_expires` |
| 33 | + - `storage=...` as the recommended path |
| 34 | + - `df/header_df` compatibility aliases |
| 35 | + - `excelalchemy.util.convertor` |
| 36 | + |
| 37 | +## Local Verification |
| 38 | + |
| 39 | +Run these commands from the repository root: |
| 40 | + |
| 41 | +```bash |
| 42 | +uv sync --extra development |
| 43 | +uv run ruff check . |
| 44 | +uv run pyright |
| 45 | +uv run pytest tests |
| 46 | +rm -rf dist |
| 47 | +uv build |
| 48 | +uvx twine check dist/* |
| 49 | +``` |
| 50 | + |
| 51 | +Optional smoke tests: |
| 52 | + |
| 53 | +```bash |
| 54 | +uv venv .pkg-smoke-base --python 3.14 |
| 55 | +uv pip install --python .pkg-smoke-base/bin/python dist/*.whl |
| 56 | +.pkg-smoke-base/bin/python -c "import excelalchemy; print(excelalchemy.__version__)" |
| 57 | +``` |
| 58 | + |
| 59 | +```bash |
| 60 | +uv venv .pkg-smoke-minio --python 3.14 |
| 61 | +uv pip install --python .pkg-smoke-minio/bin/python "dist/*.whl[minio]" |
| 62 | +.pkg-smoke-minio/bin/python -c "from excelalchemy.core.storage_minio import MinioStorageGateway; print(MinioStorageGateway.__name__)" |
| 63 | +``` |
| 64 | + |
| 65 | +## GitHub Release Steps |
| 66 | + |
| 67 | +1. Push the release commit to the default branch. |
| 68 | +2. In GitHub Releases, draft a new release. |
| 69 | +3. Create a new tag: `v2.2.0`. |
| 70 | +4. Use the `2.2.0` section from `CHANGELOG.md` as the release notes base. |
| 71 | +5. Publish the release and monitor the `Upload Python Package` workflow. |
| 72 | + |
| 73 | +## Release Focus |
| 74 | + |
| 75 | +When reviewing the final release notes, make sure they communicate these three |
| 76 | +themes clearly: |
| 77 | + |
| 78 | +- `ImportSession` now exposes a clearer lifecycle and final session snapshot |
| 79 | +- config construction is easier to read through dedicated helper constructors |
| 80 | +- explicit `storage=...` is the clear recommended backend integration path for |
| 81 | + the 2.x line |
| 82 | + |
| 83 | +## Recommended Release Messaging |
| 84 | + |
| 85 | +Prefer wording that emphasizes refinement and stability: |
| 86 | + |
| 87 | +- "continues the stable 2.x line" |
| 88 | +- "keeps the public import/export workflow API stable" |
| 89 | +- "clarifies the import runtime lifecycle" |
| 90 | +- "improves config ergonomics and backend integration guidance" |
| 91 | + |
| 92 | +## PyPI Verification |
| 93 | + |
| 94 | +After the workflow completes: |
| 95 | + |
| 96 | +1. Confirm the new release appears on PyPI. |
| 97 | +2. Confirm the long description renders correctly. |
| 98 | +3. Confirm screenshots and absolute links still work on the PyPI project page. |
| 99 | +4. Test base install: |
| 100 | + |
| 101 | +```bash |
| 102 | +pip install -U ExcelAlchemy |
| 103 | +``` |
| 104 | + |
| 105 | +5. Test optional Minio install: |
| 106 | + |
| 107 | +```bash |
| 108 | +pip install -U "ExcelAlchemy[minio]" |
| 109 | +``` |
| 110 | + |
| 111 | +6. Run one template-generation example. |
| 112 | +7. Run one import flow and one export flow. |
| 113 | + |
| 114 | +## Done When |
| 115 | + |
| 116 | +- the tag `v2.2.0` is published |
| 117 | +- the GitHub Release notes clearly communicate the three release themes |
| 118 | +- PyPI renders the project description correctly |
| 119 | +- CI, typing, tests, and package publishing all pass for the tagged release |
0 commit comments