Add program to generate changelog release entries #2626
Conversation
2opremio
force-pushed
the
changelog_generator
branch
5 times, most recently
from
7bde8ef
to
b5fb99a
Compare
|
@hiddeco I guess we could reuse this for the Helm Operator as well? Should I put it in a separate repo? |
|
@2opremio yes, this can definitely be reused by the Helm operator. May require a slight rework of the |
2opremio
force-pushed
the
changelog_generator
branch
2 times, most recently
from
beed353
to
af4811a
Compare
This Go program uses the GitHub API to automate the arduous task of creating a changelog entry for an upcoming release. It: * Automatically obtains the tag of the latest release (to know from what commit to start looking for Pull Requests). * Identifies pull requests * Attempts to categorize pull requests in subsections using tags * Generates the list of contributors
2opremio
force-pushed
the
changelog_generator
branch
from
50cd290
to
1282c3b
Compare
2opremio
changed the title
|
I decided against moving this to a new repo (it didn't feel right to create a repo just for this). I did add flags to make it runnable to for the helm operator by just providing |
2opremio
force-pushed
the
changelog_generator
branch
from
1282c3b
to
3706533
Compare
| prs := []*github.PullRequest{} | ||
| visitedPRs := map[int]struct{}{} | ||
| for _, commit := range commits { | ||
| commitProcessHook() |
There was a problem hiding this comment.
I am not super happy about this. It seems rather artificial. The alternative I considered is returning a channel and running asynchronously, but I think that's a bit overkill.
| // Note: Unfortunately this will return all the PRs whose head branch contains the commit | ||
| // (i.e. not just the PR which incorporates the commit to the base repo). | ||
| // We deal with this by discarding duplicates. | ||
| prsForCommit, _, err := ghClient.PullRequests.ListPullRequestsWithCommit(ctx, |
There was a problem hiding this comment.
Calling this on every commit is very slow (that's why I added the progress bar). As an alternative we could parse the commit messages looking for Merge messages (and messages ending with #number for rebased PRs, which don't have a Merge message). However, I deemed that to be a bit too fragile.
There was a problem hiding this comment.
You can look for commits with more than one parent. That will catch all PR merges except those that are fast-forwards, which should be none.
There was a problem hiding this comment.
That will catch all PR merges except those that are fast-forwards, which should be none.
We explicitly disable that?
There was a problem hiding this comment.
Yes I believe so. (But of course, that may change, you never know)
There was a problem hiding this comment.
Yes, I would rather not make assumptions.
Sure! What do you suggest? |
Maybe we could have:
(of which, only the latter matters here) |
2opremio
force-pushed
the
changelog_generator
branch
from
43e1056
to
b022fbc
Compare
This Go program uses the GitHub API to automate the arduous task of creating a changelog entry for an upcoming release.
It:
I still need to clean the code up before it's ready to merge (e.g. there's a hugemain()function)