Move the changelog to Towncrier fragments and build CHANGELOG.md at each deploy
维护者通常 1 天内回复
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 25/100
调研方向
Start by reading the existing deploy workflow, especially pr.yml and the workflow that deploys on merges to main, plus changelog_entry.yaml and policyengine-api's Towncrier configuration and release setup. Trace how version bumps, deployment triggers, and the GitHub App token are handled. Done means PRs require a valid fragment, each merge to main produces one release commit and one deploy, and all existing changelog entries appear in CHANGELOG.md.
由索引模型根据 Issue 内容生成。
描述
Every pull request edits one shared changelog_entry.yaml that nothing reads: no workflow, Make target or script uses it, there is no CHANGELOG.md, nothing parses it in CI (two of its entries are YAML mappings because of an unquoted : ), and it conflicts on every stack rebase. No check requires a changelog entry either.
Move the changelog to Towncrier fragments, as policyengine-api does, and fix what policyengine-api's version gets wrong:
- Fragments: one or more files per pull request,
changelog.d/<name>.<type>.md, with policyengine-api's five types (breaking, added, changed, fixed, removed), configured in a roottowncrier.toml. - A check on every pull request: a
check-changelogjob inpr.yml, inCI complete'sneeds, that fails unless the pull request itself adds a non-empty fragment directly inchangelog.d/with a configured type. policyengine-api's check counts any file anywhere underchangelog.d/, so it passed #4084'schangelog.d/added/4083.md, which its release then could not read; it also passes a pull request with no fragment while main has pending ones. The check and the release's version bump must share one definition of a fragment. - A release at each deploy: on a merge to
main, a versioning job raises a repository version from the fragment types, buildsCHANGELOG.mdwith Towncrier, removes the fragments, and pushes one release commit with the GitHub App token. Only that commit deploys; it must not start another release, and each merge must deploy once. Manual dispatch keeps working. - History:
changelog_entry.yaml's entries move intoCHANGELOG.md, with none lost, and the file is removed.
- 主要语言
- Python
- 星标
- 1
- 派生
- 1
- 平均合并
- 1 天 19 小时
- 30 天内合并 PR
- 81
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
PolicyEngine/policyengine-sim-api 的其他 Issue
-
Accept the withheld-area code lists on UK local-area breakdown results before any executor sends them可能已有人在做 @anth-volk 于 1 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 67/100
PolicyEngine/policyengine-sim-api#977 ·
维护者通常 1 天内回复
-
Update policyengine to 6.7.3可能重新可做 关联的 PR 已关闭且未合并。 未关闭
难度 2/5 半天 新手友好度 70/100
PolicyEngine/policyengine-sim-api#823 ·
维护者通常 1 天内回复
-
Integration tests fail due to missing UV virtual environment setup可能已有人在做 关联的 PR 仍在进行中或已合并。 未关闭
难度 2/5 1-3 小时 新手友好度 65/100
PolicyEngine/policyengine-sim-api#314 ·
维护者通常 1 天内回复
-
难度 5/5 一周以上 新手友好度 35/100
PolicyEngine/policyengine-sim-api#981 ·
维护者通常 1 天内回复
-
Run whole economy reports on v2 in the Simulation Entrypoint可能已有人在做 关联的 PR 仍在进行中或已合并。 未关闭
难度 5/5 一周以上 新手友好度 25/100
PolicyEngine/policyengine-sim-api#973 ·
维护者通常 1 天内回复
查看 PolicyEngine/policyengine-sim-api 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 86/100
-
Validate finite output clamping limits in StepPredictor.prepare_clamping_params to prevent silent NaN/Inf propagation可能已有人在做 @muskan-creates352 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 84/100
mllam/neural-lam#848 ·
维护者通常 2 天内回复
-
infra
难度 1/5 1 小时以内 新手友好度 88/100
fab-geocommuns/RNB-coeur#1166 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
deepspeedai/DeepSpeed#8951 ·
维护者通常 2 天内回复
-
难度 2/5 1-3 小时 新手友好度 76/100
aws/context-ontology-accelerator#343 ·
维护者通常 1 天内回复