Document disk export and deprecations in the changelog
还没有人认领这个 Issue。
评估
- 难度
- 1/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 78/100
- Issue 类型
- 文档
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- sqlite
调研方向
从 CHANGELOG.md 开始,查看现有的发布条目,了解其简短项目符号样式。在 0.8.15 上方添加 0.9.0 部分,包含列出的每一项磁盘导出、接口、弃用项和主机要求,然后运行 pre-commit run --files CHANGELOG.md;完成的标准是所有验收标准都通过。
由索引模型根据 Issue 内容生成。
描述
Overview
The changelog describes the new disk export, the new interfaces, the deprecations, and the host requirements. This issue is part of milestone M7 (verification).
Background & Motivation
This work adds a new connection type and deprecates several public names. Hosts such as Kolibri must check their routers and change their settings to use disk export. The changelog is the place where host developers find these changes.
Design: spec. Plan: implementation plan, Task 26.
Description & Expected Outcomes
A new ## 0.9.0 section at the top of CHANGELOG.md lists the changes. Each deprecated name has its replacement next to it. The host requirements are clear enough that a Kolibri developer can act on them without the spec.
Deliverables & Contracts
The changelog contains these items:
DiskSyncConnectionandMorangoProfileController.create_disk_connectionexport a fresh SQLite archive through a push.Connectionis an abstract interface with the Peer protocol.Peer*Operationclasses replaceNetwork*Operationclasses in the default settings.Network<Stage>Operationis deprecated, and the replacement isPeer<Stage>Operation. The old names handle network connections only.NetworkSyncConnection.server_infois deprecated, and the replacement ispeer_info.- The
server_cert=keyword is deprecated, and the replacement ispeer_cert=. - Host routers must allow morango migrations on aliases that start with
morango_archive_, and must returnNonefromdb_for_read/db_for_writefor morango models. Kolibri's routers already do both. - Host settings overrides must list the
Peer*operations for disk support.
Acceptance Criteria
-
CHANGELOG.mdhas a## 0.9.0section above## 0.8.15. - The section contains every item in the list of deliverables.
-
pre-commit run --files CHANGELOG.mdpasses.
Technical Pointers & Architecture
- Target Components / Context:
CHANGELOG.md. - Related Patterns: The existing release entries in
CHANGELOG.mduse one short bullet per change. - Data Model & Schema Considerations: The entry can mention the new
ArchiveManifestEntrytable, which is empty in host databases. - Resilience & Failure Modes: None.
Notes & Tradeoffs
- Dependencies: Blocked by: #386 (parity and end-to-end tests). Blocks: none.
- Compatibility & Migrations: The spec leaves open the release that removes the deprecated names. Removal requires the Kolibri companion changes in spec §3.9.
Metadata
- Complexity: Low
- Target Branch: release-v0.9.x
AI Usage
Drafted with Claude (Claude Code) from the approved design spec and implementation plan. The author reviewed the requirements, and the code references were checked against the release-v0.9.x codebase.
- 主要语言
- Python
- 星标
- 15
- 派生
- 23
- 平均合并
- 1 天 11 小时
- 30 天内合并 PR
- 4
环境准备
- 提供 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
learningequality/morango 的其他 Issue
-
DEV: backend DEV: dev-ops TAG: unit tests
难度 2/5 1-3 小时 新手友好度 70/100
learningequality/morango#385 ·
-
DEV: backend P0 - critical TAG: tech update / debt TAG: unit tests
难度 2/5 1-3 小时 新手友好度 72/100
learningequality/morango#364 ·
-
DEV: backend TAG: new feature
难度 5/5 一周以上 新手友好度 10/100
learningequality/morango#388 ·
-
DEV: backend TAG: unit tests
难度 4/5 3-5 天 新手友好度 55/100
learningequality/morango#386 ·
-
DEV: backend P0 - critical TAG: new feature
难度 4/5 3-5 天 新手友好度 38/100
learningequality/morango#384 ·
查看 learningequality/morango 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 72/100
Graphify-Labs/graphify#4241 · 1 条评论 ·
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 72/100
-
DeviceTracker未关闭
难度 2/5 1-3 小时 新手友好度 63/100
XiaoMi/ha_xiaomi_home#1821 ·
维护者通常 1 天内回复
-
Maven path-index: "Ambiguous or noncanonical artifact path" error does not report the offending path未关闭
难度 2/5 1-3 小时 新手友好度 76/100
pulp/pulp_maven#524 ·
维护者通常 1 天内回复
-
难度 1/5 1-3 小时 新手友好度 82/100
维护者通常 1 天内回复