docs(release): credit all contributors via an Acknowledgements section#288
Open
pinodeca wants to merge 1 commit into
Open
docs(release): credit all contributors via an Acknowledgements section#288pinodeca wants to merge 1 commit into
pinodeca wants to merge 1 commit into
Conversation
Step 5 previously kept only GitHub's auto 'New Contributors' block, which lists first-time contributors only, so returning contributors got no credit in the release notes. Fetch the generated notes once and mine every 'by @handle' from the (otherwise dropped) 'What's Changed' dump to build a full thank-you list, with bots stripped. Title the section 'Acknowledgements' rather than 'Contributors' so it does not duplicate GitHub's native 'Contributors' avatar widget on the release page.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fix the release procedure so release notes credit all contributors, not just first-timers.
Step 5 of
prompts/pg_durable-release.mdpreviously kept only GitHub's auto-generated New Contributors block (which lists first-time contributors only) and dropped the What's Changed PR dump — the only place with per-PR authorship. Returning contributors therefore got no credit in the notes.Changes
generate-notesoutput once into a temp file and reuse it.by @handlefrom it to build a full thank-you list (deduped, bots like@dependabot/@github-actionsstripped).## Acknowledgements, not## Contributors— GitHub auto-renders its own native "Contributors" avatar widget on the release page, so a body heading of the same name produces a duplicate, confusing section (observed on thev0.2.4-rc1draft).Context
Surfaced while cutting v0.2.4 (tracking issue #286). The
v0.2.4-rc1release notes have already been corrected by hand to use## Acknowledgements; this PR bakes the fix into the procedure so the finalv0.2.4and future releases get it automatically.Docs-only change to the release prompt.