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

Decide on a better strategy for release notes/changelogs #3784

Open
djc opened this issue Apr 23, 2024 · 3 comments
Open

Decide on a better strategy for release notes/changelogs #3784

djc opened this issue Apr 23, 2024 · 3 comments
Labels
enhancement meta This issue is related to project management.
Milestone

Comments

@djc
Copy link
Contributor

djc commented Apr 23, 2024

Currently, we're generating changelogs with a Python script. This is trying to mimic the exact format that rustup posts on the Rust blog have been in the past, but it would be nice to simplify this approach.

See more discussion in #3773 (comment).

@djc djc added the bug label Apr 23, 2024
@rami3l rami3l added enhancement and removed bug labels Apr 23, 2024
@rami3l rami3l added this to the 1.28.0 milestone Apr 23, 2024
@rami3l
Copy link
Member

rami3l commented Apr 23, 2024

I don't think we should necessarily make the blog posts on the Rust blog actually like they have been before. In particular, IMO listing all contributors in the blog post is overkill (the Rust blog doesn't do that for Rust releases) and could be deferred to the changelog here.

Yeah, it's kinda tedious really. I wish I wouldn't have to spend like an hour (maybe two or more for the 0.1s?) per release night just to figure this out. Maybe the release blog posts are written in this way because... people tend to do what the Romans do to be safe, but things don't have to be this way.

#3773 (comment)

@djc I have an idea! What about making rust-lang/thanks recognize us as well? The fact that we're currently not recognized on https://thanks.rust-lang.org is something I been always wanting to point out since a while ago. This way, we can just use a link towards that page to replace the whole section, just like Rustc does right now; also, all the Rustup contributors can then get the credit they deserve!

@rami3l rami3l modified the milestones: 1.28.0, On Deck Apr 23, 2024
@rami3l
Copy link
Member

rami3l commented Apr 24, 2024

On the other hand, rust-lang/rfcs#3503 has been merged and it seems that the cargo feature is already partially implemented. I think we can adopt cargo-script early with either this script or gen-workflows.sh.

@rami3l rami3l changed the title Decide on a better strategy for release notes/changelogs Meta: decide on a better strategy for release notes/changelogs Apr 24, 2024
@rami3l rami3l changed the title Meta: decide on a better strategy for release notes/changelogs Decide on a better strategy for release notes/changelogs Apr 24, 2024
@rami3l rami3l added the meta This issue is related to project management. label Apr 24, 2024
@djc
Copy link
Contributor Author

djc commented Apr 24, 2024

Adding rustup to thanks seems nice, but I worry that it might be quite a bit of work, since from the description it looks like it might currently be tied into rust-lang/rust stuff.

I prefer boring/familiar stuff because it will be easier to maintain so I'd prefer to avoid cargo script until it actually lands in the stable toolchain.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement meta This issue is related to project management.
Projects
None yet
Development

No branches or pull requests

2 participants