Skip to content

Conversation

straight-shoota
Copy link
Member

@straight-shoota straight-shoota commented Jan 13, 2024

This new script automates editing the autogenerated changelog from scripts/github-changelog.cr into CHANGELOG.md.

We have automated the changelog editing process that it requires almost no human work. The changelog entries are entirely generated from the pull request data from the GitHub milestone.

This tool re-generates the changelog for any version with a single command.

This could even allow us to move the entire changelog process into a CI action which runs at a regular interval (daily?) and updates the changelog branch. This means during a release period the changelog already grows with unreleased changes.

Depends on #14229

@straight-shoota
Copy link
Member Author

straight-shoota commented Jan 13, 2024

For demonstration: This script generated everything about #14232 (except for the commit to delete the unintentionally commited script itself 🙈)

#14229 is necessary for any updates to work.

@straight-shoota straight-shoota marked this pull request as ready for review February 6, 2024 13:26
@hugopl
Copy link
Contributor

hugopl commented Mar 16, 2024

I think using this script in a github action after every PR gets merged will create much noise in the repository.

@straight-shoota
Copy link
Member Author

Yeah, for sure. That's not indended. The idea would be to run this in regular intervals, maybe daily.

@straight-shoota straight-shoota added this to the 1.12.0 milestone Apr 5, 2024
@straight-shoota straight-shoota merged commit c32e5a9 into crystal-lang:master Apr 6, 2024
@straight-shoota straight-shoota deleted the infra/update-changelog branch April 6, 2024 18:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants