Update release notes process - #1356
Open
jezdez wants to merge 3 commits into
Open
Conversation
3 tasks
conda-bot
added
the
cla-signed
jezdez
force-pushed
the
feature/release-news-process
branch
from
June 5, 2026 11:47
5a1cff3 to
7d7a832
Compare
danyeaw
reviewed
Aug 12, 2026
danyeaw
left a comment
danyeaw
left a comment
Member
There was a problem hiding this comment.
Should we also update RELEASE_ON_DEMAND.md in this PR, or would you prefer to make it a separate update after we have the workflow working fully on conda?
| - The consumed `news/` snippets should be deleted from the generated branch. | ||
|
|
||
| 8. Push this versioned branch. | ||
| 11. Add first-time contributor information if the project includes contributor notes in `CHANGELOG.md`. |
Member
There was a problem hiding this comment.
Since the new action doesn't generate the Contributors section, I think we need to make that part of step 11 for now, something like:
11. Add a `### Contributors` section on the generated release-notes PR if the project includes one in `CHANGELOG.md`.
`prepare-release` aggregates news sections only; it does not write Contributors (rever used to embed this list).
- Generate the release notes on GitHub once. Use the contributor handles shown in the generated notes to append a Contributors section under the new `## [[ placeholder ]]` entry. For each person listed under **New Contributors**, include their first pull request link on the same line:
### Contributors
* @alice
* @bob made their first contribution in <https://github.com/[[ repo.user ]]/[[ repo.name ]]/pull/123>
See [GitHub docs][release docs] for generating release notes.
- Commit on the release-notes PR branch:
$ git add CHANGELOG.md
$ git commit -m "Add contributors"
| $ git commit -m "Update .mailmap" | ||
| ``` | ||
|
|
||
| - Continue repeating the above processes until the `.authors.yml` and `.mailmap` are corrected to your liking. After completing this, you will have at most two commits on your release branch: |
Member
There was a problem hiding this comment.
This is probably a pre-existing issue, but it looks like we aren't commiting changes to AUTHORS.md here. This might be fine to leave alone though, since we are working to get rid of these rever steps.
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
3 participants
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.
Description
Updates the shared release-process template to describe the new fragment-first release notes flow:
prepare-releasegenerated release-notes PR flow.CHANGELOG.mdand consumednews/snippets.Refs #556
Related implementation PRs: