+1 on using the changelog. IMO until we start requiring comprehensible change notes in all PRs (not in the PR title/description or commit title/message but in the actual repo itself), manually editing the CHANGELOG.md is the best candidate we have for comprehensible release notes. I think we're getting better at making sure significant new features/changes get added to CHANGELOG.md, but we're probably lacking in the area of bugfix notes. Bugfix notes are hard because they're really only pertinent to the changelog if they are bugs that exist in a release. In master we introduce and fix bugs all the time, so we'd have to determine if the bug actually afflicts the latest release or not. If it affects the latest release, we should add it to the CHANGELOG.md.
- Rawlin On Tue, Feb 26, 2019 at 2:39 PM Robert Butts <[email protected]> wrote: > > +1 on using the Changelog for the Release Notes. I think that's why we > decided to make a Changelog, and I made an attempt at pulling down PR > titles between 3.0 and 2.2, it's possible, but it's not easy to get right. > The Changelog is more precise and human-readable anyway. > > On Tue, Feb 26, 2019 at 2:16 PM Gelinas, Derek <[email protected]> > wrote: > > > While prepping 3.0.0 for release, I noticed that our old method of pulling > > up PRs for the release notes, changelog.pl, no longer functions > > properly. It relies upon tagging we no longer use. So the way I see it, > > we have two options: > > > > > > 1. Some sort of script that pulls down the PRs since x date (the date > > of the last release’s first RC) and then somehow strips the backports that > > are in the last release as well as the PRs since the current release’s > > first RC that were not backported. > > 2. We use the changelog. For this release, we’ll want folks to check > > the changelog to make sure nothing is missing of theirs. For future > > releases, we continue the debate about how we build a proper changelog and > > finalize something. Anything. > > > > I welcome everyone’s thoughts, and hope we can get this sorted out ASAP so > > we can get 3.0.0 into the world. It’s the last step. > > > > Derek > >
