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

feat: auto generate release notes #57698

Merged
merged 1 commit into from
May 27, 2022

Conversation

casswedson
Copy link
Contributor

Summary

None

Purpose of change

Github is able to generate some pretty nice looking release notes, we don't have much time between releases, so it's not gonna be a large release changelog, still pretty things are very nice to have

Describe the solution

It took some time to figure out how to do this but this pretty much explained all the needed steps for me https://github.com/cli/cli/blob/trunk/.github/workflows/releases.yml#L24 https://github.com/cli/cli/blob/trunk/.github/workflows/releases.yml#L45

I don't think many people look at the releases, but it's nice to have a simple changelog with pr title and listed contributors
see a changelog with a lot more pr in it https://github.com/I-am-Erk/CDDA-Tilesets/releases/tag/2022-05-08

Describe alternatives you've considered

Testing

See this release https://github.com/casswedson/Cataclysm-DDA/releases/tag/cdda-experimental-2022-05-14-1831 generated by this commit and pr casswedson@d18a84e casswedson#35

Additional context

@github-actions github-actions bot added Code: Tooling Tooling that is not part of the main game but is part of the repo. astyled astyled PR, label is assigned by github actions json-styled JSON lint passed, label assigned by github actions labels May 14, 2022
@Maleclypse
Copy link
Member

Does this count all our daily prereleases or will this only do the actual releases (stable to stable)? Either is an excellent addition.

@casswedson
Copy link
Contributor Author

casswedson commented May 14, 2022

This is targeting experimental pre-releases, tho making a changelog like this one for the stable releases is one click away https://docs.github.com/en/enterprise-cloud@latest/repositories/releasing-projects-on-github/automatically-generated-release-notes

still I would not think release notes like this one could replace the existing one, because is much simpler, not as fancy and less specific

remind me to bring this up next release for the contributor and new contributors list, that would be a nice addition

@github-actions github-actions bot added the BasicBuildPassed This PR builds correctly, label assigned by github actions label May 14, 2022
@dseguin dseguin merged commit ece0575 into CleverRaven:master May 27, 2022
@casswedson casswedson deleted the automatic-release-notes branch May 27, 2022 02:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
astyled astyled PR, label is assigned by github actions BasicBuildPassed This PR builds correctly, label assigned by github actions Code: Tooling Tooling that is not part of the main game but is part of the repo. json-styled JSON lint passed, label assigned by github actions
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants