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

Create a script to generate changelog on releases #1754

Closed
Raffo opened this issue Aug 26, 2020 · 9 comments · Fixed by #1794
Closed

Create a script to generate changelog on releases #1754

Raffo opened this issue Aug 26, 2020 · 9 comments · Fixed by #1794
Labels
kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt.

Comments

@Raffo
Copy link
Contributor

Raffo commented Aug 26, 2020

Currently we have a PR template that asks contributors to add a line to the changelog. This is done to ease the release process, but it creates the problem that whenever we merge a PR, all the other open PRs have a conflict with the changelog file.
We should create a script to automate the generation of the changelog from the GitHub API instead of relying on a manually edited file.

@seanmalloy
Copy link
Member

/kind cleanup

@k8s-ci-robot k8s-ci-robot added the kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. label Aug 26, 2020
@seanmalloy
Copy link
Member

@Raffo and @njuettner what do you think would something like this be acceptable to you?

I might be able to work on this. Let me know what you think. Thanks!

@seanmalloy
Copy link
Member

@vinny-sabatini is going take this on. Thanks!

@ddgenome
Copy link
Contributor

There are tools that do this for you already https://go.atomist.com/catalog/skills/atomist/keep-a-changelog-skill

@Raffo
Copy link
Contributor Author

Raffo commented Aug 29, 2020

@seanmalloy I don't have a strong preference on how it is done. The key metric that I have is "time to make a release". For a process that is as simple as ExternalDNS, it takes me 30 mins of active work plus wait for all the docker images to be built. I want to lower this time significantly such that when I have to make a release it will only take a few (single digit) minutes.
I'd be happy to review a PR to address that 👍

@vinny-sabatini
Copy link
Contributor

I am hoping to work on this soon, but I don't know if I will have time until next week. I will make sure to comment here when I am ready to start working on it.

If no one picks this up before I have time to work on it, I was planning on implementing something as @seanmalloy mentioned because I am not currently a member of the kubernetes-sigs org and would not have access to add an app to this repo.

@Raffo
Copy link
Contributor Author

Raffo commented Sep 2, 2020

If no one picks this up before I have time to work on it, I was planning on implementing something as @seanmalloy mentioned because I am not currently a member of the kubernetes-sigs org and would not have access to add an app to this repo.

Apps are tricky to add, following what @seanmalloy proposed sounds good to me.

@timja
Copy link
Contributor

timja commented Sep 9, 2020

This is really good: https://github.com/release-drafter/release-drafter
and doesn't require an app just a GitHub action

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants