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

Incrementally compile release notes #969

Open
BD103 opened this issue Feb 16, 2024 · 3 comments
Open

Incrementally compile release notes #969

BD103 opened this issue Feb 16, 2024 · 3 comments
Labels
A-Build-System C-Enhancement New feature or request

Comments

@BD103
Copy link
Member

BD103 commented Feb 16, 2024

Originally from Discord.

It would be amazing if release notes could be incrementally compiled, so there is always a draft page of migration guides and release notes for the next version. This would reduce the amount of effort required for each release, so Alice and Cart can spend more time developing and less drafting. This would work well with our deployment process, which already automatically runs daily.

@TrialDragon
Copy link
Member

A random thought; I wonder if it's worth adding a Release Notes section to PRs on the main repo like the Migration Guide section so that folks can document what's relevant while it's fresh in their heads. Then either, a stub is generated like with migration guide or something along those lines, or maybe someone just brings over the relevant release notes as they're deemed relevant.

TL;DR Make release notes workflow similar to current migration guide workflow to minimize work needed.

@BD103
Copy link
Member Author

BD103 commented Feb 17, 2024

That's an interesting idea.a

For this issue specifically, I was more thinking of building the migration guide from latest...main nightly, so you could view all breaking changes as they were made.

@TrialDragon
Copy link
Member

Apparently even as public draft the articles will show in the RSS feed since they must have a date to be rendered due to the overarching sections sort_by = "date". So that may be an issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Build-System C-Enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants