-
Notifications
You must be signed in to change notification settings - Fork 10
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
ci: build changelog automatically #54
Conversation
e5456ec
to
4b3539d
Compare
7cee723
to
22d1f97
Compare
96f29a5
to
84069c5
Compare
.github/workflows/prerelease.yml
Outdated
issues: true | ||
issuesWoLabels: true | ||
pullRequests: true | ||
prWoLabels: true |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These four shouldn't need to be specified. A bug has been reported upstream: janheinrichmerker/action-github-changelog-generator#23
uses: heinrichreimer/github-changelog-generator-action@v2.2 | ||
with: | ||
token: ${{ secrets.GITHUB_TOKEN }} | ||
issues: true |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i would not add issues. We will end up populating the changelog with things that are not related to code changes like this one
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can try to add issues but only those with labels (bug
, enhancement
, etc.) and see how it comes.
Excellent tool , this will automate the changelog and give it richer info. I just have a concern about the issues that are added in the changelog. |
Looks good. Is the PRs section always named "Merged pull requests" ? Ideally we would have sections named "Added", "Changed" and "Fixed" but i guess we can't control this very well. I think I had tried this tool before and didn't see how we could do that, although I didn't spend much time with it. |
Due to the increased complexity and upstream bugs we're dropping this from the epic for now. Closing. |
This PR (attempts to) implement automated changelog generation for releases.
Goals:
Feedback
The generated changelog for the singe release can be found here
The generated full changelog can be viewed with the following command:
Or in this gist: https://gist.github.com/roobre/ae85275179856928c4807e5033865eaa
Appending release notes can be done by opening a "meta-issue", which is a bit cumbersome but still doable. The action has support for noticing features, bugfixes, and breaking changes depending on issue labels. The full capabilities of the generator can be seen here