feat(framework): credit GitHub contributors in generated release notes
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 55/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Bastante claro
- Estado de actividad
- Activo
- Stack tecnológico
- github, github-actions, typescript
Línea de trabajo
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.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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.
- Lenguaje dominante
- TypeScript
- Estrellas
- 481
- Forks
- 45
- Merge medio
- 19 h 38 min
- PR fusionados (30 d)
- 108
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de ai-driven-dev/framework
-
refactor(aidd-orchestrator): the check zone says when to stop, and reviews its axes in one round Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
ai-driven-dev/framework#887 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
ai-driven-dev/framework#873 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 85/100
ai-driven-dev/framework#872 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
ai-driven-dev/framework#625 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
ai-driven-dev/framework#467 · 1 comentario ·
Todos los issues de ai-driven-dev/framework
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
mksglu/context-mode#1200 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
jaegertracing/jaeger-ui#4506 ·
-
area:desktop area:ui bug platform:macos
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
anthropics/claude-code#96687 ·
-
good first issue
Dificultad 1/5 Menos de una hora Aptitud para principiantes 95/100
AOSSIE-Org/DebateAI#582 · 2 comentarios ·