Skip to content

Commit b3cf7fc

Browse files
committed
feat(v2.1): update docs
1 parent 64b7081 commit b3cf7fc

4 files changed

Lines changed: 47 additions & 13 deletions

File tree

CHANGELOG.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ All notable changes to this project will be documented in this file.
44

55
The format is inspired by Keep a Changelog and versioned according to PEP 440.
66

7-
## [2.1.0] - Unreleased
7+
## [2.1.0] - 2026-04-02
88

9-
This release continues the 2.x line with internal architecture cleanup, naming
10-
improvements, and stronger separation between long-lived facade state and
11-
single-run import workflow state.
9+
This release continues the stable 2.x line with internal architecture cleanup,
10+
clearer naming, and a stronger separation between the long-lived facade and the
11+
single-run import workflow runtime.
1212

1313
### Added
1414

@@ -55,6 +55,14 @@ single-run import workflow state.
5555
standard deprecation warning that points to `excelalchemy.util.converter`
5656
- No public import/export workflow API was removed in this release
5757

58+
### Release Summary
59+
60+
- `ExcelAlchemy` is now a lighter facade, with single-run import state handled
61+
by `ImportSession`
62+
- internal configuration now has clearer schema, behavior, and storage layers
63+
- metadata internals are more structured without forcing users to rewrite
64+
existing `FieldMeta(...)` or `ExcelMeta(...)` declarations
65+
5866
## [2.0.0.post1] - 2026-03-28
5967

6068
This post-release updates the package presentation and release metadata for the

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ This repository is also a design artifact.
1616
It documents a series of deliberate engineering choices: `src/` layout, Pydantic v2 migration, pandas removal,
1717
pluggable storage, `uv`-based workflows, and locale-aware workbook output.
1818

19-
The current stable release line is `2.1.0`, which continues the stable ExcelAlchemy 2.x line with internal architecture cleanup and naming improvements.
19+
The current stable release is `2.1.0`, which continues the ExcelAlchemy 2.x line with a lighter import facade, clearer internal layering, and naming cleanup.
2020

2121
## At a Glance
2222

README_cn.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
ExcelAlchemy 是一个面向 Excel 导入导出的 schema-first Python 库。
66
它的核心思路不是“读写表格文件”,而是“把 Excel 当成一种带约束的业务契约”。
77

8-
当前稳定发布版本是 `2.1.0`,它在稳定的 ExcelAlchemy 2.x 线上继续推进了内部架构整理和命名收口
8+
当前稳定发布版本是 `2.1.0`,它在稳定的 ExcelAlchemy 2.x 线上继续推进了导入 facade 轻量化、内部结构分层和命名收口
99

1010
你用 Pydantic 模型定义结构,用 `FieldMeta` 定义 Excel 元数据,用显式的导入/导出流程去完成模板生成、数据校验、错误回写和后端集成。
1111

docs/releases/2.1.0.md

Lines changed: 33 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,33 @@
11
# 2.1.0 Release Checklist
22

3-
This checklist is intended for the first feature release on top of the stable
4-
2.0 line.
3+
This checklist is intended for the first 2.1 stable release on top of the
4+
stable 2.x line.
55

66
## Purpose
77

8-
- publish the first 2.1 release of ExcelAlchemy
8+
- publish the first stable 2.1 release of ExcelAlchemy
99
- ship the sessionized import workflow architecture
1010
- ship internal config normalization and metadata layering without breaking the
1111
public 2.x API
1212
- confirm that naming cleanup and compatibility shims are documented clearly
1313

14+
## Release Positioning
15+
16+
`2.1.0` should be presented as an architectural refinement release:
17+
18+
- the public 2.x workflow stays stable
19+
- the internal import workflow becomes more explicit through `ImportSession`
20+
- config and metadata become easier to reason about internally
21+
- compatibility paths remain available for 2.x users
22+
1423
## Before Tagging
1524

1625
1. Confirm the intended version in `src/excelalchemy/__init__.py`.
1726
2. Review the `2.1.0` section in `CHANGELOG.md`.
1827
3. Confirm `README.md`, `README-pypi.md`, and `MIGRATIONS.md` still describe the
1928
recommended public paths correctly.
20-
4. Confirm the compatibility notes for:
29+
4. Confirm `README_cn.md` is still aligned with the current release position.
30+
5. Confirm the compatibility notes for:
2131
- `excelalchemy.util.convertor`
2232
- `df/header_df` compatibility aliases
2333
- legacy Minio config path
@@ -63,13 +73,22 @@ uv pip install --python .pkg-smoke-minio/bin/python "dist/*.whl[minio]"
6373
When reviewing the final release notes, make sure they communicate these three
6474
themes clearly:
6575

66-
- `ExcelAlchemy` is now a lighter facade because import runtime state moved into
67-
`ImportSession`
68-
- config is still easy to construct publicly, but internally it is now split
76+
- `ExcelAlchemy` is now a lighter facade because import runtime state moved
77+
into `ImportSession`
78+
- config remains easy to construct publicly, but internally it is now split
6979
into schema, behavior, and storage layers
7080
- metadata now has clearer internal layering without forcing users to rewrite
7181
their `FieldMeta(...)` or `ExcelMeta(...)` declarations
7282

83+
## Recommended Release Messaging
84+
85+
Prefer wording that emphasizes refinement rather than disruption:
86+
87+
- "continues the stable 2.x line"
88+
- "keeps the public import/export workflow API stable"
89+
- "improves internal architecture and maintainability"
90+
- "preserves 2.x compatibility paths while moving the implementation forward"
91+
7392
## PyPI Verification
7493

7594
After the workflow completes:
@@ -91,3 +110,10 @@ pip install -U "ExcelAlchemy[minio]"
91110

92111
6. Run one template-generation example.
93112
7. Run one import flow and one export flow.
113+
114+
## Done When
115+
116+
- the tag `v2.1.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

Comments
 (0)