Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial implementation of relnotes handler #1835

Merged
merged 3 commits into from
Aug 25, 2024

Conversation

Mark-Simulacrum
Copy link
Member

This follows up on recent discussion with T-libs-api (in particular) to make it easier for T-release and teams to propose specific text for inclusion in release notes. The strategy proposed here is a dedicated issue for release note text discussion + revision. Follow-up work to this will automate pulling the relevant context into the release notes PR (likely through changes to https://github.com/rust-lang/relnotes/), but manually extracting it should already be pretty easy due to the prominent title.

There are many future improvements, e.g.:

  • Automatic nomination for the right team based on initial PR labels
  • Automatic creation for any FCP (this feels right to me, but it is more work than teams typically do today).
  • Random assignment to (subset of?) team members rather than nomination?
  • Live-ish rendering of the proposed content, perhaps by replacing the code blocks with some other delimiter.

But my hope is that we can iterate on this in practice as we gain experience.

cc @rust-lang/release

r? @ehuss

@Mark-Simulacrum
Copy link
Member Author

We discussed in the last release team meeting using a GitHub project for tracking this, but I decided to not pursue that here. The "text" input in those is very limited (basically just one line) which doesn't feel great, and also lacks a clear place to discuss the changes being proposed, which also doesn't feel right. Long-term, I think having a clearly separate place for discussing how changes should be announced to the public also feels like a good thing, since it creates a dedicated point on every team's change process rather than making that a separate activity done weeks after decisions are made (and typically by different people).

src/github.rs Outdated Show resolved Hide resolved
src/handlers/relnotes.rs Outdated Show resolved Hide resolved
Mark-Simulacrum and others added 2 commits August 24, 2024 17:52
Co-authored-by: Eric Huss <[email protected]>
Co-authored-by: Eric Huss <[email protected]>
Copy link
Contributor

@ehuss ehuss left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Feel free to merge when you are ready.

@Mark-Simulacrum Mark-Simulacrum merged commit 49024fc into rust-lang:master Aug 25, 2024
2 checks passed
@Mark-Simulacrum Mark-Simulacrum deleted the relnotes-issues branch August 25, 2024 11:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants