|
| 1 | +# 3.0.0 Release Notes and Checklist |
| 2 | + |
| 3 | +This document records the final release positioning and verification checklist |
| 4 | +for the stable `3.0.0` release. |
| 5 | + |
| 6 | +## Purpose |
| 7 | + |
| 8 | +- publish the first stable ExcelAlchemy 3.0 package |
| 9 | +- finalize the breaking 3.0 public API around typed Pydantic models and |
| 10 | + explicit `ExcelColumn(...)` workbook metadata |
| 11 | +- confirm current docs, examples, and smoke assets describe 3.0 instead of the |
| 12 | + retired 2.x compatibility surface |
| 13 | +- trigger the GitHub Release workflow that builds, verifies, and publishes the |
| 14 | + Python package to PyPI |
| 15 | + |
| 16 | +## Release Positioning |
| 17 | + |
| 18 | +`3.0.0` is a stable breaking release: |
| 19 | + |
| 20 | +- Python type annotations define the data shape |
| 21 | +- Pydantic `Field(...)` stays responsible for Pydantic validation |
| 22 | +- `ExcelColumn(...)` carries workbook-facing metadata |
| 23 | +- codec helpers are explicit objects instead of fake Python scalar/container |
| 24 | + types |
| 25 | +- storage configuration uses `storage=...` with an `ExcelStorage` |
| 26 | + implementation |
| 27 | +- 2.x compatibility imports, legacy config fields, and facade aliases are no |
| 28 | + longer current API |
| 29 | + |
| 30 | +## Before Tagging |
| 31 | + |
| 32 | +1. Confirm the package version in `src/excelalchemy/__init__.py` is `3.0.0`. |
| 33 | +2. Confirm `pyproject.toml` no longer marks the package as alpha. |
| 34 | +3. Review the `3.0.0` section in `CHANGELOG.md`. |
| 35 | +4. Confirm README entry points describe ExcelAlchemy 3.0 as stable: |
| 36 | + - `README.md` |
| 37 | + - `README-pypi.md` |
| 38 | + - `README_cn.md` |
| 39 | +5. Confirm the release smoke scripts: |
| 40 | + - `scripts/smoke_package.py` |
| 41 | + - `scripts/smoke_examples.py` |
| 42 | + - `scripts/smoke_docs_assets.py` |
| 43 | + - `scripts/smoke_api_payload_snapshot.py` |
| 44 | + |
| 45 | +## Local Verification |
| 46 | + |
| 47 | +Run these commands from the repository root: |
| 48 | + |
| 49 | +```bash |
| 50 | +uv run ruff format --check . |
| 51 | +uv run ruff check . |
| 52 | +uv run pyright |
| 53 | +uv run pytest --cov=excelalchemy --cov-report=term-missing:skip-covered tests |
| 54 | +uv run python scripts/smoke_package.py |
| 55 | +uv run python scripts/smoke_examples.py |
| 56 | +uv run python scripts/smoke_docs_assets.py |
| 57 | +uv run python scripts/smoke_api_payload_snapshot.py |
| 58 | +uv build |
| 59 | +uvx twine check dist/* |
| 60 | +``` |
| 61 | + |
| 62 | +## GitHub Release Steps |
| 63 | + |
| 64 | +1. Push the release commit. |
| 65 | +2. Create and publish the tag `v3.0.0`. |
| 66 | +3. Publish a GitHub Release for `v3.0.0` using this document and the |
| 67 | + `CHANGELOG.md` entry as release-note sources. |
| 68 | +4. Confirm the `Upload Python Package` workflow succeeds. |
| 69 | +5. Confirm the published package version is `3.0.0`. |
| 70 | + |
| 71 | +The publish workflow verifies that the release tag, after removing the `v` |
| 72 | +prefix, matches `excelalchemy.__version__`. |
0 commit comments