That's right, I forgot about that script. I think that script no longer worked when we moved to using Jira for our issues instead of Github issues. If we move back to Github it's possible that we could use the script again. I found an example of what the script output looked like: https://github.com/Comcast/traffic_control/releases/tag/RELEASE-1.6.0. I can live with the output from the script but there are a few things that a changelog file would give us that I think are better: 1) It's "real-time". If I recall correctly, the script was only run at release time (hence the github release) instead of being real time; this makes it hard to understand what has changed since the last release before we actually create a new release. This also makes it difficult when testing new release candidates. 2) It lumps together bug fixes and new features. If we have a manually created file we can keep bug fixes and new features separate which makes it more user-friendly.
I do see the issue with merge conflicts, but maybe that is worth the benefit of having the file? I think that is something to consider when voting. Another potentially annoying issue is that you need to create a PR to get a PR number and then add a commit for adding the PR number (link) to the change log. On Wed, May 17, 2017 at 12:18 PM, Phil Sorber <[email protected]> wrote: > Don't we have a script that can generate this? ATS had this for a long time > and it became a huge hassle. It caused merge conflicts all the time, that > while easy to address, were a huge nuisance. It also ended up out of date > often. > > On Wed, May 17, 2017 at 10:11 AM Gelinas, Derek <[email protected] > > > wrote: > > > +1 for sure. It'll also give us a way to scan the notes and see what > needs > > documenting and what doesn't yet have it. > > > > > On May 17, 2017, at 11:44 AM, Dave Neuman <[email protected]> wrote: > > > > > > Hey All, > > > One thing we discussed at the meetup was the addition of a CHANGELOG.md > > > file to the project. This file will contain changes that are made to > > the > > > project including bug fixes and new features. (e.g. > > > https://github.com/influxdata/influxdb/blob/master/CHANGELOG.md). > > Adding > > > this file means that we will now require each PR to contain an update > to > > > the CHANGELOG.md file, and our documentation will need to be updated > > > accordingly. > > > I thought it would be good to open a vote for adding this file, and if > it > > > passes, I will update the documentation and add a CHANGELOG.md file. > > > > > > Thanks, > > > Dave > > >
