Move the changelog to Towncrier fragments and build CHANGELOG.md at each deploy
メンテナーはふだん 1 日以内に返信
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 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時間
- マージ済み PR（30日）
- 81
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- 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 が 2 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 67/100
PolicyEngine/policyengine-sim-api#977 ·
メンテナーはふだん 1 日以内に返信
-
Update policyengine to 6.7.3再び着手できるかも このイシューのプルリクエストはマージされずにクローズされました。 オープン
難易度 2/5 半日 初心者へのやさしさ 70/100
PolicyEngine/policyengine-sim-api#823 ·
メンテナーはふだん 1 日以内に返信
-
Integration tests fail due to missing UV virtual environment setup対応中かも このイシューにリンクされたプルリクエストがオープン中、またはマージ済みです。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
PolicyEngine/policyengine-sim-api#314 ·
メンテナーはふだん 1 日以内に返信
-
Calculate budget windows on the v2 economy path対応中かも このイシューにリンクされたプルリクエストがオープン中、またはマージ済みです。 オープン
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
PolicyEngine/policyengine-sim-api#981 ·
メンテナーはふだん 1 日以内に返信
-
Run whole economy reports on v2 in the Simulation Entrypoint対応中かも このイシューにリンクされたプルリクエストがオープン中、またはマージ済みです。 オープン
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
PolicyEngine/policyengine-sim-api#973 ·
メンテナーはふだん 1 日以内に返信
PolicyEngine/policyengine-sim-api の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
メンテナーはふだん 2 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
メンテナーはふだん 2 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
developmentseed/titiler-cmr#278 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
メンテナーはふだん 2 日以内に返信