feat(framework): credit GitHub contributors in generated release notes
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 55/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 活発
- 技術スタック
- github, github-actions, typescript
調査の方向性
Start by reading release-please-config.json and .github/workflows/ci.yml, then compare the generated v5.10.0 release. Trace where root and component release notes are produced and run the existing tests before changing behavior. Done means human PR authors are credited once per applicable release, bots are excluded, and repeated generation remains unchanged.
索引モデルが issue の本文から書いたものです。
説明
Problem
Release Please lists changes, pull requests and commits, but the generated GitHub releases do not credit the people behind them by GitHub handle.
The current v5.10.0 release contains no @handle mentions.
Scope
- After release-please creates the releases, a CI step appends each changelog line's commit author as
(@handle)(Symfony-style), in every GitHub release of the cycle: root and each component. A component credits only the authors of its own commits. mainaccepts only merge commits (rulesetallowed_merge_methods: ["merge"]), so a promote can be neither squashed nor rebased. The release PR switches from--squash --adminto--merge --admin; ahotfix/*lands as a merge commit.
Findings
Verified in a throwaway sandbox repository (since deleted) and against this repository, read-only.
- release-please's native
include-commit-authorscredits nobody in 17.11.2, the latest release:parseConventionalCommitsdrops the commit author. Upstream bug googleapis/release-please#2761, fix googleapis/release-please#2892 still open. Hence the post-processing step. changelog-type: githubis rejected: it reads the whole range between tags, which is wrong for component releases.- A prototype of the step, run twice on the sandbox's releases, credited every line and changed nothing the second time. A read-only dry run over
v5.10.0credited all 44 lines, including those ending in, closes #…. - On the last 60 PRs merged into
next, the squash commit's author is the PR author (55/55 humans), even when someone else merges. - Editing a release fires
release: edited;back-merge.ymllistens only topublished, so crediting does not re-run it. - Under a merge-only ruleset, a bypass actor in
pull_requestmode (the live mode foraidd-botand teamadmin) still cannot squash, even with--admin. The current--squash --adminrelease merge would therefore be refused: the release PR must move to--mergebefore the live ruleset changes. - A release PR merged as a merge commit is tagged normally (sandbox, and #135 /
v4.1.0here). commitlint ignoresMerge pull request …subjects. Back-merge and a second cycle work unchanged. - A squashed promote makes release-please report "No user facing commits found": the week's entries vanish from the notes without any signal.
Acceptance criteria
- Every changelog line that links a commit, in every GitHub release of a cycle, ends with its commit author's
@handle, or the author's name when no account resolves. - A component release credits only authors of commits in that component.
- Re-running the step changes nothing.
- Tests cover multiple contributors, a repeated contributor, a bot, a
closes #Nline, a line without a SHA, and an already-credited line. -
mainrefuses squash and rebase merges;.github/rulesets/main.jsonand the live ruleset agree. - The release PR merges with
--merge --admin, is tagged, and back-merge still foldsmainintonext. - The live ruleset changes only after one release has merged with
--merge. - Each guard ships with a test that fails when the guard is removed.
Accepted tradeoffs
- Per-line credit only: no contributor section, no deduplication.
- The maintainer is credited like everyone else;
(@dependabot[bot])appears on dependency lines. - Only the GitHub releases carry handles;
CHANGELOG.mdand the release PR body do not. - A multi-author PR credits its author only;
Co-authored-by:trailers are ignored. - A
hotfix/*lands as a merge commit instead of a squash. - Bullets under
⚠ BREAKING CHANGESlink no commit and stay uncredited; the same commit is credited on its own line in its section.
Follow-up
- Once googleapis/release-please#2892 ships in a pinned
release-please-action: turn oninclude-commit-authors, delete the post-processing step and its script, and check a release still credits every line.
Prior art in this repo
release-please-config.json.github/workflows/ci.yml.github/workflows/promote.yml.github/rulesets/main.json- Release
v5.10.0. - Brief and plan:
aidd_docs/tasks/2026_09/2026_09_23_credit-contributors-release-notes/
Out of scope
- Rewriting Git history.
- Other forms of contribution (issues, reviews, discussions).
- A contributor section or recap list.
- A weekly shout-out on overall contribution (separate issue).
- Manually maintained changelogs.
- 主要言語
- TypeScript
- スター
- 481
- フォーク
- 45
- 平均マージ
- 19時間 38分
- マージ済み PR(30日)
- 108
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
ai-driven-dev/framework のほかの issue
-
refactor(aidd-orchestrator): the check zone says when to stop, and reviews its axes in one round オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
ai-driven-dev/framework#887 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
ai-driven-dev/framework#873 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
ai-driven-dev/framework#872 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
ai-driven-dev/framework#625 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
ai-driven-dev/framework#467 · コメント 1 件 ·
ai-driven-dev/framework の issue をすべて見る
似ている issue
-
bug(cli): hapi doctor inline-media prints a fabricated B:\ helper-script path in packaged installs オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
-
Crush オープン
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
catppuccin/catppuccin#3125 ·
-
Add a SECURITY.md オープン
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
ElementsProject/cln-application#167 · コメント 1 件 · リアクション 1 件 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
Quantco/pnpm-licenses#17 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100