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

Consider using the new github release notes #2299

Closed
roberthbailey opened this issue Oct 7, 2021 · 1 comment
Closed

Consider using the new github release notes #2299

roberthbailey opened this issue Oct 7, 2021 · 1 comment
Labels
area/build-tools Development tooling. I.e. pretty much everything in the `build` directory. help wanted We would love help on these issues. Please come help us! kind/feature New features for Agones

Comments

@roberthbailey
Copy link
Member

Is your feature request related to a problem? Please describe.

We current use the docker container ferrarimarco/github-changelog-generator to generate our release notes. It queries the github API for closed issues / merged PRs in the current milestone and generates our CHANGELOG which we use as the basis for the release notes in github as well as the blog post (e.g. 1.18.0-rc).

Github recently announced that they have a new tool to help generate release notes: https://github.blog/2021-10-04-beta-github-releases-improving-release-experience/

We should investigate their solution and see how it would work for our project.

Describe alternatives you've considered
Keep our current release note generator. One downside of the current process is that the generator sends a large number of requests to the github API, which can fail if you hit throttling / rate limiting while running the tool. It also reviews the entire history of closed issues / merged PRs, which makes it more likely to hit these failures the longer our project exists.

@roberthbailey roberthbailey added the kind/feature New features for Agones label Oct 7, 2021
@roberthbailey roberthbailey added the help wanted We would love help on these issues. Please come help us! label Oct 28, 2021
@roberthbailey roberthbailey added the area/build-tools Development tooling. I.e. pretty much everything in the `build` directory. label Jan 31, 2022
@gongmax
Copy link
Collaborator

gongmax commented Apr 26, 2023

This is already fixed by #3022 , closing

@gongmax gongmax closed this as completed Apr 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/build-tools Development tooling. I.e. pretty much everything in the `build` directory. help wanted We would love help on these issues. Please come help us! kind/feature New features for Agones
Projects
None yet
Development

No branches or pull requests

2 participants