-
Notifications
You must be signed in to change notification settings - Fork 1
release: prepare ExcelAlchemy 2.2.8 #68
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
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
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
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,95 @@ | ||
| # Integration Roadmap | ||
|
|
||
| This page helps you choose a reading path through the ExcelAlchemy docs based on | ||
| what you are trying to build. | ||
|
|
||
| If you want the fastest general entry point, start with | ||
| [`docs/getting-started.md`](https://github.com/RayCarterLab/ExcelAlchemy/blob/main/docs/getting-started.md). | ||
| If you want screenshots and captured workflow output first, see | ||
| [`docs/examples-showcase.md`](https://github.com/RayCarterLab/ExcelAlchemy/blob/main/docs/examples-showcase.md). | ||
|
|
||
| ## 1. If You Are Integrating ExcelAlchemy For The First Time | ||
|
|
||
| Recommended order: | ||
|
|
||
| 1. [`docs/getting-started.md`](https://github.com/RayCarterLab/ExcelAlchemy/blob/main/docs/getting-started.md) | ||
| 2. [`docs/public-api.md`](https://github.com/RayCarterLab/ExcelAlchemy/blob/main/docs/public-api.md) | ||
| 3. [`examples/README.md`](https://github.com/RayCarterLab/ExcelAlchemy/blob/main/examples/README.md) | ||
| 4. [`docs/examples-showcase.md`](https://github.com/RayCarterLab/ExcelAlchemy/blob/main/docs/examples-showcase.md) | ||
|
|
||
| Focus on these concepts first: | ||
|
|
||
| - stable import paths | ||
| - schema declaration style | ||
| - `storage=...` as the recommended backend integration path | ||
| - the difference between import, create-or-update, and export workflows | ||
|
|
||
| ## 2. If You Are Building A Backend API | ||
|
|
||
| Recommended order: | ||
|
|
||
| 1. [`docs/result-objects.md`](https://github.com/RayCarterLab/ExcelAlchemy/blob/main/docs/result-objects.md) | ||
| 2. [`docs/api-response-cookbook.md`](https://github.com/RayCarterLab/ExcelAlchemy/blob/main/docs/api-response-cookbook.md) | ||
| 3. [`examples/fastapi_reference/README.md`](https://github.com/RayCarterLab/ExcelAlchemy/blob/main/examples/fastapi_reference/README.md) | ||
| 4. [`docs/public-api.md`](https://github.com/RayCarterLab/ExcelAlchemy/blob/main/docs/public-api.md) | ||
|
|
||
| Focus on these objects: | ||
|
|
||
| - `ImportResult` | ||
| - `CellErrorMap` | ||
| - `RowIssueMap` | ||
|
|
||
| Use these payload helpers directly in your API layer: | ||
|
|
||
| - `ImportResult.to_api_payload()` | ||
| - `CellErrorMap.to_api_payload()` | ||
| - `RowIssueMap.to_api_payload()` | ||
|
|
||
| ## 3. If You Are Building Frontend Error Displays | ||
|
|
||
| Recommended order: | ||
|
|
||
| 1. [`docs/result-objects.md`](https://github.com/RayCarterLab/ExcelAlchemy/blob/main/docs/result-objects.md) | ||
| 2. [`docs/api-response-cookbook.md`](https://github.com/RayCarterLab/ExcelAlchemy/blob/main/docs/api-response-cookbook.md) | ||
| 3. [`examples/fastapi_reference/README.md`](https://github.com/RayCarterLab/ExcelAlchemy/blob/main/examples/fastapi_reference/README.md) | ||
|
|
||
| Focus on these payload fields: | ||
|
|
||
| - `code` | ||
| - `message_key` | ||
| - `message` | ||
| - `display_message` | ||
|
|
||
| And these grouped or summary helpers: | ||
|
|
||
| - `summary.by_field` | ||
| - `summary.by_row` | ||
| - `summary.by_code` | ||
| - `facets.field_labels` | ||
| - `facets.codes` | ||
| - `facets.row_numbers_for_humans` | ||
| - `grouped.messages_by_field` | ||
| - `grouped.messages_by_row` | ||
| - `grouped.messages_by_code` | ||
|
|
||
| ## 4. If You Want Copyable Reference Code | ||
|
|
||
| Start here: | ||
|
|
||
| - [`examples/employee_import_workflow.py`](https://github.com/RayCarterLab/ExcelAlchemy/blob/main/examples/employee_import_workflow.py) | ||
| - [`examples/create_or_update_import.py`](https://github.com/RayCarterLab/ExcelAlchemy/blob/main/examples/create_or_update_import.py) | ||
| - [`examples/export_workflow.py`](https://github.com/RayCarterLab/ExcelAlchemy/blob/main/examples/export_workflow.py) | ||
| - [`examples/fastapi_reference/README.md`](https://github.com/RayCarterLab/ExcelAlchemy/blob/main/examples/fastapi_reference/README.md) | ||
|
|
||
| ## 5. If You Need Migration And Compatibility Context | ||
|
|
||
| Read: | ||
|
|
||
| 1. [`MIGRATIONS.md`](https://github.com/RayCarterLab/ExcelAlchemy/blob/main/MIGRATIONS.md) | ||
| 2. [`docs/public-api.md`](https://github.com/RayCarterLab/ExcelAlchemy/blob/main/docs/public-api.md) | ||
|
|
||
| This is the best route when you need to answer: | ||
|
|
||
| - which imports are stable | ||
| - which imports are compatibility-only | ||
| - how the 2.x line treats legacy Minio configuration |
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,65 @@ | ||
| # 2.2.8 Release Notes and Checklist | ||
|
|
||
| This document records the final release positioning and verification checklist | ||
| for the `2.2.8` release on top of the stable 2.x line. | ||
|
|
||
| ## Purpose | ||
|
|
||
| - record the final stable 2.x integration-polish release package for ExcelAlchemy | ||
| - make the documentation set easier to navigate for first-time adopters, | ||
| backend API builders, and frontend error consumers | ||
| - harden release smoke verification around a stable import-failure API payload | ||
| snapshot | ||
| - exercise the FastAPI reference app more directly during install-time release | ||
| checks | ||
|
|
||
| ## Release Positioning | ||
|
|
||
| `2.2.8` should be presented as a stable 2.x documentation-and-release-hardening | ||
| release: | ||
|
|
||
| - the public import and export workflow API stays stable | ||
| - new adopters now have a clearer role-based reading path | ||
| - release verification now checks a stable import-failure payload shape | ||
| - installed-package smoke exercises the FastAPI reference demo more directly | ||
|
|
||
| ## Before Tagging | ||
|
|
||
| 1. Review the `2.2.8` section in `CHANGELOG.md`. | ||
| 2. Confirm the new documentation entry points: | ||
| - `docs/integration-roadmap.md` | ||
| - `docs/getting-started.md` | ||
| - `docs/public-api.md` | ||
| 3. Confirm the payload snapshot asset: | ||
| - `files/example-outputs/import-failure-api-payload.json` | ||
| 4. Confirm the release smoke scripts: | ||
| - `scripts/generate_example_output_assets.py` | ||
| - `scripts/smoke_api_payload_snapshot.py` | ||
| - `scripts/smoke_docs_assets.py` | ||
| - `scripts/smoke_examples.py` | ||
| 5. Confirm the FastAPI reference demo still runs directly: | ||
| - `python -m examples.fastapi_reference.app` | ||
|
|
||
| ## Local Verification | ||
|
|
||
| Run these commands from the repository root: | ||
|
|
||
| ```bash | ||
| uv run ruff check . | ||
| uv run pyright | ||
| uv run pytest -q | ||
| ./.venv/bin/python scripts/generate_example_output_assets.py | ||
| ./.venv/bin/python scripts/smoke_api_payload_snapshot.py | ||
| ./.venv/bin/python scripts/smoke_docs_assets.py | ||
| ./.venv/bin/uv run --with fastapi --with httpx --with python-multipart python -m examples.fastapi_reference.app | ||
| rm -rf dist | ||
| uv build | ||
| uvx twine check dist/* | ||
| ``` | ||
|
|
||
| ## 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.8`. | ||
| 4. Use the short release notes summary from the release PR or release draft. |
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.
scripts/generate_example_output_assets.pynow rewritesfiles/example-outputs/import-failure-api-payload.json, and this workflow invokes it immediately beforescripts/smoke_api_payload_snapshot.py; that makes the smoke check compare against a just-regenerated file instead of the committed baseline, so API payload contract regressions can slip through unnoticed. I checked the same ordering in bothci.ymlandpython-publish.yml, so the release smoke currently gives a false sense of snapshot stability.Useful? React with 👍 / 👎.