I am +1 on this approach, I know it's manual and there could be conflicts and it's a bit of a PITA, but I think it actually has some benefits in that a human can actually enter in important release notes that are readable and make sense. That being said if someone is willing to make an automated approach work, that allows us to keep track of changes at a reasonable level (not per commit, not necessarily even per PR), then I could be +1 on that as well. I would need to someone volunteer to make it work before I give my +1 though. Either way, we REALLY need a changelog that is updated regularly with important information.
--Dave On Wed, Dec 13, 2017 at 3:00 PM, Steve Malenfant <[email protected]> wrote: > Hey All, > > There has been a vote on not maintaining a CHANGELOG file in the past and > seems like we leaned toward an automated process. I believe none of them > had happened (please correct me if not). > > I have been upgrading Traffic Control from 2.1 to 2.2 this week and found > numerous gotchas. > > Some examples of things I ran into and luckily I was able to get good > support from the Slack channels. Here is a few example of possible breaking > changes : > > - Delivery Service prefixes disappeared after upgrade, was not handled in > postinstall (requires special attention, this was on this forum and well > documented on the mailing list) > - Traffic Ops Golang doesn't connect to a Riak with self-signed > certificates > - Riak security grant needs updated > - cdn.conf configuration change > - Traffic Portal required for new features (URI Signing) > - cachekey plugin instead of cacheurl > > There was great enhancements made in 2.2 needs to be noticed by current and > new users. If we are looking to get more engagement, that's probably the > #1 thing to do. I usually go and read about all the other components which > we use around the Traffic Control CDN (Influx, Elastic, Grafana, etc...) > > So let me re-quote what Dave has sent and ask the same question again. > > ====== > 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 > ====== > > I'm a +1 on CHANGELOG, but I'm not heavy creating PRs which kind influence > my vote. > > Steve >
