-
Notifications
You must be signed in to change notification settings - Fork 1
feat(v2.2.1): release: prepare ExcelAlchemy 2.2.1 #58
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
+263
−58
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,112 @@ | ||
| # 2.2.1 Release Checklist | ||
|
|
||
| This checklist is intended for the `2.2.1` release on top of the stable 2.x | ||
| line. | ||
|
|
||
| ## Purpose | ||
|
|
||
| - publish the next stable 2.x refinement release of ExcelAlchemy | ||
| - present `2.2.1` as a metadata-consolidation and typing-tightening release | ||
| - keep the public 2.x workflow stable while making internal metadata structures | ||
| more immutable | ||
| - continue reducing hidden shared state and internal type ambiguity | ||
|
|
||
| ## Release Positioning | ||
|
|
||
| `2.2.1` should be presented as an architectural refinement release: | ||
|
|
||
| - the public import and export workflow API stays stable | ||
| - metadata internals become more immutable and easier to reason about | ||
| - facade-level metadata mutation remains ergonomic while internal layering gets | ||
| safer | ||
| - the Pydantic adapter layer continues moving toward clearer type boundaries | ||
|
|
||
| ## Before Tagging | ||
|
|
||
| 1. Confirm the intended version in `src/excelalchemy/__init__.py`. | ||
| 2. Review the `2.2.1` section in `CHANGELOG.md`. | ||
| 3. Confirm `README.md`, `README-pypi.md`, and `MIGRATIONS.md` still describe | ||
| the recommended public paths correctly. | ||
| 4. Confirm `README_cn.md` remains aligned with the current release position. | ||
| 5. Confirm the compatibility notes for: | ||
| - `FieldMeta(...)` and `ExcelMeta(...)` as stable public metadata entry points | ||
| - internal metadata layering remaining an implementation detail | ||
| - `storage=...` as the recommended backend path | ||
|
|
||
| ## Local Verification | ||
|
|
||
| Run these commands from the repository root: | ||
|
|
||
| ```bash | ||
| uv sync --extra development | ||
| uv run ruff check . | ||
| uv run pyright | ||
| uv run pytest tests | ||
| rm -rf dist | ||
| uv build | ||
| uvx twine check dist/* | ||
| ``` | ||
|
|
||
| Optional smoke tests: | ||
|
|
||
| ```bash | ||
| uv venv .pkg-smoke-base --python 3.14 | ||
| uv pip install --python .pkg-smoke-base/bin/python dist/*.whl | ||
| .pkg-smoke-base/bin/python -c "import excelalchemy; print(excelalchemy.__version__)" | ||
| ``` | ||
|
|
||
| ## GitHub Release Steps | ||
|
|
||
| 1. Push the release commit to the default branch. | ||
| 2. In GitHub Releases, draft a new release. | ||
| 3. Create a new tag: `v2.2.1`. | ||
| 4. Use the `2.2.1` section from `CHANGELOG.md` as the release notes base. | ||
| 5. Publish the release and monitor the `Upload Python Package` workflow. | ||
|
|
||
| ## Release Focus | ||
|
|
||
| When reviewing the final release notes, make sure they communicate these three | ||
| themes clearly: | ||
|
|
||
| - metadata internals are now more immutable and less prone to hidden shared state | ||
| - facade-level metadata updates preserve 2.x ergonomics while internal layers | ||
| are replaced structurally | ||
| - the Pydantic adapter layer now has clearer type boundaries | ||
|
|
||
| ## Recommended Release Messaging | ||
|
|
||
| Prefer wording that emphasizes refinement and stability: | ||
|
|
||
| - "continues the stable 2.x line" | ||
| - "keeps the public import/export workflow API stable" | ||
| - "makes metadata internals more immutable" | ||
| - "tightens internal type boundaries without forcing public API changes" | ||
|
|
||
| ## PyPI Verification | ||
|
|
||
| After the workflow completes: | ||
|
|
||
| 1. Confirm the new release appears on PyPI. | ||
| 2. Confirm the long description renders correctly. | ||
| 3. Confirm screenshots and absolute links still work on the PyPI project page. | ||
| 4. Test base install: | ||
|
|
||
| ```bash | ||
| pip install -U ExcelAlchemy | ||
| ``` | ||
|
|
||
| 5. Test optional Minio install: | ||
|
|
||
| ```bash | ||
| pip install -U "ExcelAlchemy[minio]" | ||
| ``` | ||
|
|
||
| 6. Run one template-generation example. | ||
| 7. Run one import flow and one export flow. | ||
|
|
||
| ## Done When | ||
|
|
||
| - the tag `v2.2.1` is published | ||
| - the GitHub Release notes clearly communicate the three release themes | ||
| - PyPI renders the project description correctly | ||
| - CI, typing, tests, and package publishing all pass for the tagged release |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
_extract_pydantic_modelnow unconditionally falls through toyield field_adapter.runtime_metadata()for every non-composite type, so models likename: str = FieldMeta(...)are accepted instead of being rejected. That storesstrasexcel_codec, and later import validation callsself.excel_codec.normalize_import_value(...), which raises runtimeAttributeErrorrather than a clear configurationProgrammaticErrorat startup. This is a regression from the previousissubclass(excel_codec, ExcelFieldCodec)guard and makes invalid model declarations fail much later and less predictably.Useful? React with 👍 / 👎.