Repository navigation
Change log is not updated since version 4.18.4 #1406
Description
The last record at CHANGELOG.md is for version 4.18.4 (2022-12-30).
I wonder if this is intentional or not, and also what has changed since. @kzu, can you please fill it in?
Activity
[-]Change log is updated since version 4.18.4[/-][+]Change log is not updated since version 4.18.4[/+]kzu commentedon Aug 21, 2023
It was previously manually updated by @stakx. I do automated changelog in all my repos, but I just noticed that even if the action run green there was an error when updating from the GH action: https://github.com/moq/moq/actions/runs/5836450586/job/15830043450
Checking why that didn't commit... Thanks for reporting!
Manually update CHANGELOG.md for now
Manually update CHANGELOG.md for now
stakx commentedon Aug 21, 2023
In fact it was expanded by whomever submitted relevant code changes. I only updated the "Unreleased" headers with version numbers immediately prior to a new release.
I'm curious though, how does your automated changelog creation process work? Is it based on the titles and authors of issues & PRs that went into a release?
(The reason why I thought that a manually edited file was OK was that issue & PR titles often aren't the best possible summary for a bug or change (from a user perspective), and sometimes you may want to add some additional notes that couldn't be derived from them. Also, not all issues and PRs may be significant, so manually deciding to omit some them may remove some noise from the log.)
kzu commentedon Aug 21, 2023
It uses a config file and the github changelog generator.
So, labels become important, as well as PR titles. Once you factor in this fact, what I usually do is amend PR titles with that in mind.
While the changelog is fully automated, the release notes aren't. That uses GH's built-in button to generate the release notes while you create a release from its own config which is very very close to the changelog generator itself. This feature came a bit after I started doing the automated changelog generation, so perhaps I should invest some time in unifying them so the direct notes from the actual release (potentially manually tweaked) make it to the changelog.md as-is. But right now, that's the mix.