You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@trafficcontrol.apache.org by Dave Neuman <ne...@apache.org> on 2017/05/17 15:43:51 UTC
[VOTE] Adding a CHANGELOG.md file
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
Re: [VOTE] Adding a CHANGELOG.md file
Posted by Dave Neuman <ne...@apache.org>.
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 <so...@apache.org> 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 <Derek_Gelinas@comcast.com
> >
> 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 <ne...@apache.org> 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
> >
>
Re: [VOTE] Adding a CHANGELOG.md file
Posted by David Neuman <da...@gmail.com>.
I am calling this vote closed and failed. It is clear that we do not want
to have to manually manage a changelog file; at a minimum it should be an
automated process.
On Wed, May 17, 2017 at 2:43 PM, Eric Friedrich (efriedri) <
efriedri@cisco.com> wrote:
> The Influx Changelog contains sections for Features vs Bugfixes.
>
> I personally find that useful and would like to keep something similar in
> our Changelog. Hopefully with JIRA or Issues we can indicate with a label
> or tag which section this item should go into (defaulting to Bugfix to not
> be a pain)
>
> —Eric
>
>
> > On May 17, 2017, at 2:34 PM, Dave Neuman <ne...@apache.org> wrote:
> >
> > yeah, something that creates an automated Changelog.MD file is better
> than
> > putting it in a github release. If I understood the talks I went to
> > earlier, Apache does not like it when you create a "release" before you
> > actually vote on release candidates, etc.
> >
> > I am +1 with an automated release, once we move to "full" github.
> >
> > On Wed, May 17, 2017 at 1:22 PM, Dan Kirkwood <da...@gmail.com> wrote:
> >
> >> yeah -- what Hank said...
> >>
> >> On Wed, May 17, 2017 at 11:17 AM, Hank Beatty <hb...@apache.org>
> wrote:
> >>> -1 for a manual changelog - doing a compare between branches/commits in
> >>> github is relatively simple.
> >>>
> >>> +1 for a scripted changelog -
> >>> https://github.com/skywinder/github-changelog-generator - There is
> even
> >> a
> >>> list of alternatives:
> >>> https://github.com/skywinder/Github-Changelog-Generator/
> >> wiki/Alternatives
> >>>
> >>> On 05/17/2017 12:52 PM, Phil Sorber wrote:
> >>>>
> >>>> Here is a link to an example script generated CHANGES file from Jira:
> >>>>
> >>>> https://raw.githubusercontent.com/apache/trafficserver/6.0.x/CHANGES
> >>>>
> >>>> On Wed, May 17, 2017 at 10:48 AM Phil Sorber <so...@apache.org>
> wrote:
> >>>>
> >>>>> The script can be updated to do Jira. ATS used a Jira version before
> >> they
> >>>>> went to github. You can also separate out easily. In fact, we did it
> >> more
> >>>>> easily with Jira than with github, since those categories are
> mutually
> >>>>> exclusive in Jira and labels in github are not. You could also have a
> >>>>> developer run the script regularly, or have CI do it.
> >>>>>
> >>>>> To Eric's comment, if you can make that indication in Jira/GitHub
> then
> >>>>> you
> >>>>> can transition that to the script. For example, a "Changelog" label
> in
> >>>>> github that would mean to have it included.
> >>>>>
> >>>>> On Wed, May 17, 2017 at 10:37 AM Eric Friedrich (efriedri) <
> >>>>> efriedri@cisco.com> wrote:
> >>>>>
> >>>>>> What about a compromise where developer chooses whether or not a
> >>>>>> feature/important fix is worth mentioning in the release notes. This
> >>>>>> would
> >>>>>> be at feature granularity not individual commit.
> >>>>>>
> >>>>>> Then at release build time, a script gathers from JIRA/Github API
> all
> >>>>>> fixes that were committed in that release and checks that into repo.
> >>>>>>
> >>>>>> —Eric
> >>>>>>
> >>>>>>> On May 17, 2017, at 12:18 PM, Phil Sorber <so...@apache.org>
> 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 <
> >>>>>>
> >>>>>> Derek_Gelinas@comcast.com>
> >>>>>>>
> >>>>>>> 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 <ne...@apache.org>
> >> 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
> >>>>>>>>
> >>>>>>>>
> >>>>>>
> >>>>>>
> >>>>
> >>>
> >>
>
>
Re: [VOTE] Adding a CHANGELOG.md file
Posted by "Eric Friedrich (efriedri)" <ef...@cisco.com>.
The Influx Changelog contains sections for Features vs Bugfixes.
I personally find that useful and would like to keep something similar in our Changelog. Hopefully with JIRA or Issues we can indicate with a label or tag which section this item should go into (defaulting to Bugfix to not be a pain)
—Eric
> On May 17, 2017, at 2:34 PM, Dave Neuman <ne...@apache.org> wrote:
>
> yeah, something that creates an automated Changelog.MD file is better than
> putting it in a github release. If I understood the talks I went to
> earlier, Apache does not like it when you create a "release" before you
> actually vote on release candidates, etc.
>
> I am +1 with an automated release, once we move to "full" github.
>
> On Wed, May 17, 2017 at 1:22 PM, Dan Kirkwood <da...@gmail.com> wrote:
>
>> yeah -- what Hank said...
>>
>> On Wed, May 17, 2017 at 11:17 AM, Hank Beatty <hb...@apache.org> wrote:
>>> -1 for a manual changelog - doing a compare between branches/commits in
>>> github is relatively simple.
>>>
>>> +1 for a scripted changelog -
>>> https://github.com/skywinder/github-changelog-generator - There is even
>> a
>>> list of alternatives:
>>> https://github.com/skywinder/Github-Changelog-Generator/
>> wiki/Alternatives
>>>
>>> On 05/17/2017 12:52 PM, Phil Sorber wrote:
>>>>
>>>> Here is a link to an example script generated CHANGES file from Jira:
>>>>
>>>> https://raw.githubusercontent.com/apache/trafficserver/6.0.x/CHANGES
>>>>
>>>> On Wed, May 17, 2017 at 10:48 AM Phil Sorber <so...@apache.org> wrote:
>>>>
>>>>> The script can be updated to do Jira. ATS used a Jira version before
>> they
>>>>> went to github. You can also separate out easily. In fact, we did it
>> more
>>>>> easily with Jira than with github, since those categories are mutually
>>>>> exclusive in Jira and labels in github are not. You could also have a
>>>>> developer run the script regularly, or have CI do it.
>>>>>
>>>>> To Eric's comment, if you can make that indication in Jira/GitHub then
>>>>> you
>>>>> can transition that to the script. For example, a "Changelog" label in
>>>>> github that would mean to have it included.
>>>>>
>>>>> On Wed, May 17, 2017 at 10:37 AM Eric Friedrich (efriedri) <
>>>>> efriedri@cisco.com> wrote:
>>>>>
>>>>>> What about a compromise where developer chooses whether or not a
>>>>>> feature/important fix is worth mentioning in the release notes. This
>>>>>> would
>>>>>> be at feature granularity not individual commit.
>>>>>>
>>>>>> Then at release build time, a script gathers from JIRA/Github API all
>>>>>> fixes that were committed in that release and checks that into repo.
>>>>>>
>>>>>> —Eric
>>>>>>
>>>>>>> On May 17, 2017, at 12:18 PM, Phil Sorber <so...@apache.org> 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 <
>>>>>>
>>>>>> Derek_Gelinas@comcast.com>
>>>>>>>
>>>>>>> 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 <ne...@apache.org>
>> 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
>>>>>>>>
>>>>>>>>
>>>>>>
>>>>>>
>>>>
>>>
>>
Re: [VOTE] Adding a CHANGELOG.md file
Posted by Dave Neuman <ne...@apache.org>.
yeah, something that creates an automated Changelog.MD file is better than
putting it in a github release. If I understood the talks I went to
earlier, Apache does not like it when you create a "release" before you
actually vote on release candidates, etc.
I am +1 with an automated release, once we move to "full" github.
On Wed, May 17, 2017 at 1:22 PM, Dan Kirkwood <da...@gmail.com> wrote:
> yeah -- what Hank said...
>
> On Wed, May 17, 2017 at 11:17 AM, Hank Beatty <hb...@apache.org> wrote:
> > -1 for a manual changelog - doing a compare between branches/commits in
> > github is relatively simple.
> >
> > +1 for a scripted changelog -
> > https://github.com/skywinder/github-changelog-generator - There is even
> a
> > list of alternatives:
> > https://github.com/skywinder/Github-Changelog-Generator/
> wiki/Alternatives
> >
> > On 05/17/2017 12:52 PM, Phil Sorber wrote:
> >>
> >> Here is a link to an example script generated CHANGES file from Jira:
> >>
> >> https://raw.githubusercontent.com/apache/trafficserver/6.0.x/CHANGES
> >>
> >> On Wed, May 17, 2017 at 10:48 AM Phil Sorber <so...@apache.org> wrote:
> >>
> >>> The script can be updated to do Jira. ATS used a Jira version before
> they
> >>> went to github. You can also separate out easily. In fact, we did it
> more
> >>> easily with Jira than with github, since those categories are mutually
> >>> exclusive in Jira and labels in github are not. You could also have a
> >>> developer run the script regularly, or have CI do it.
> >>>
> >>> To Eric's comment, if you can make that indication in Jira/GitHub then
> >>> you
> >>> can transition that to the script. For example, a "Changelog" label in
> >>> github that would mean to have it included.
> >>>
> >>> On Wed, May 17, 2017 at 10:37 AM Eric Friedrich (efriedri) <
> >>> efriedri@cisco.com> wrote:
> >>>
> >>>> What about a compromise where developer chooses whether or not a
> >>>> feature/important fix is worth mentioning in the release notes. This
> >>>> would
> >>>> be at feature granularity not individual commit.
> >>>>
> >>>> Then at release build time, a script gathers from JIRA/Github API all
> >>>> fixes that were committed in that release and checks that into repo.
> >>>>
> >>>> —Eric
> >>>>
> >>>>> On May 17, 2017, at 12:18 PM, Phil Sorber <so...@apache.org> 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 <
> >>>>
> >>>> Derek_Gelinas@comcast.com>
> >>>>>
> >>>>> 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 <ne...@apache.org>
> 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
> >>>>>>
> >>>>>>
> >>>>
> >>>>
> >>
> >
>
Re: [VOTE] Adding a CHANGELOG.md file
Posted by Dan Kirkwood <da...@gmail.com>.
yeah -- what Hank said...
On Wed, May 17, 2017 at 11:17 AM, Hank Beatty <hb...@apache.org> wrote:
> -1 for a manual changelog - doing a compare between branches/commits in
> github is relatively simple.
>
> +1 for a scripted changelog -
> https://github.com/skywinder/github-changelog-generator - There is even a
> list of alternatives:
> https://github.com/skywinder/Github-Changelog-Generator/wiki/Alternatives
>
> On 05/17/2017 12:52 PM, Phil Sorber wrote:
>>
>> Here is a link to an example script generated CHANGES file from Jira:
>>
>> https://raw.githubusercontent.com/apache/trafficserver/6.0.x/CHANGES
>>
>> On Wed, May 17, 2017 at 10:48 AM Phil Sorber <so...@apache.org> wrote:
>>
>>> The script can be updated to do Jira. ATS used a Jira version before they
>>> went to github. You can also separate out easily. In fact, we did it more
>>> easily with Jira than with github, since those categories are mutually
>>> exclusive in Jira and labels in github are not. You could also have a
>>> developer run the script regularly, or have CI do it.
>>>
>>> To Eric's comment, if you can make that indication in Jira/GitHub then
>>> you
>>> can transition that to the script. For example, a "Changelog" label in
>>> github that would mean to have it included.
>>>
>>> On Wed, May 17, 2017 at 10:37 AM Eric Friedrich (efriedri) <
>>> efriedri@cisco.com> wrote:
>>>
>>>> What about a compromise where developer chooses whether or not a
>>>> feature/important fix is worth mentioning in the release notes. This
>>>> would
>>>> be at feature granularity not individual commit.
>>>>
>>>> Then at release build time, a script gathers from JIRA/Github API all
>>>> fixes that were committed in that release and checks that into repo.
>>>>
>>>> —Eric
>>>>
>>>>> On May 17, 2017, at 12:18 PM, Phil Sorber <so...@apache.org> 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 <
>>>>
>>>> Derek_Gelinas@comcast.com>
>>>>>
>>>>> 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 <ne...@apache.org> 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
>>>>>>
>>>>>>
>>>>
>>>>
>>
>
Re: [VOTE] Adding a CHANGELOG.md file
Posted by Hank Beatty <hb...@apache.org>.
-1 for a manual changelog - doing a compare between branches/commits in
github is relatively simple.
+1 for a scripted changelog -
https://github.com/skywinder/github-changelog-generator - There is even
a list of alternatives:
https://github.com/skywinder/Github-Changelog-Generator/wiki/Alternatives
On 05/17/2017 12:52 PM, Phil Sorber wrote:
> Here is a link to an example script generated CHANGES file from Jira:
>
> https://raw.githubusercontent.com/apache/trafficserver/6.0.x/CHANGES
>
> On Wed, May 17, 2017 at 10:48 AM Phil Sorber <so...@apache.org> wrote:
>
>> The script can be updated to do Jira. ATS used a Jira version before they
>> went to github. You can also separate out easily. In fact, we did it more
>> easily with Jira than with github, since those categories are mutually
>> exclusive in Jira and labels in github are not. You could also have a
>> developer run the script regularly, or have CI do it.
>>
>> To Eric's comment, if you can make that indication in Jira/GitHub then you
>> can transition that to the script. For example, a "Changelog" label in
>> github that would mean to have it included.
>>
>> On Wed, May 17, 2017 at 10:37 AM Eric Friedrich (efriedri) <
>> efriedri@cisco.com> wrote:
>>
>>> What about a compromise where developer chooses whether or not a
>>> feature/important fix is worth mentioning in the release notes. This would
>>> be at feature granularity not individual commit.
>>>
>>> Then at release build time, a script gathers from JIRA/Github API all
>>> fixes that were committed in that release and checks that into repo.
>>>
>>> —Eric
>>>
>>>> On May 17, 2017, at 12:18 PM, Phil Sorber <so...@apache.org> 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 <
>>> Derek_Gelinas@comcast.com>
>>>> 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 <ne...@apache.org> 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
>>>>>
>>>
>>>
>
Re: [VOTE] Adding a CHANGELOG.md file
Posted by Phil Sorber <so...@apache.org>.
Here is a link to an example script generated CHANGES file from Jira:
https://raw.githubusercontent.com/apache/trafficserver/6.0.x/CHANGES
On Wed, May 17, 2017 at 10:48 AM Phil Sorber <so...@apache.org> wrote:
> The script can be updated to do Jira. ATS used a Jira version before they
> went to github. You can also separate out easily. In fact, we did it more
> easily with Jira than with github, since those categories are mutually
> exclusive in Jira and labels in github are not. You could also have a
> developer run the script regularly, or have CI do it.
>
> To Eric's comment, if you can make that indication in Jira/GitHub then you
> can transition that to the script. For example, a "Changelog" label in
> github that would mean to have it included.
>
> On Wed, May 17, 2017 at 10:37 AM Eric Friedrich (efriedri) <
> efriedri@cisco.com> wrote:
>
>> What about a compromise where developer chooses whether or not a
>> feature/important fix is worth mentioning in the release notes. This would
>> be at feature granularity not individual commit.
>>
>> Then at release build time, a script gathers from JIRA/Github API all
>> fixes that were committed in that release and checks that into repo.
>>
>> —Eric
>>
>> > On May 17, 2017, at 12:18 PM, Phil Sorber <so...@apache.org> 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 <
>> Derek_Gelinas@comcast.com>
>> > 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 <ne...@apache.org> 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
>> >>
>>
>>
Re: [VOTE] Adding a CHANGELOG.md file
Posted by Phil Sorber <so...@apache.org>.
The script can be updated to do Jira. ATS used a Jira version before they
went to github. You can also separate out easily. In fact, we did it more
easily with Jira than with github, since those categories are mutually
exclusive in Jira and labels in github are not. You could also have a
developer run the script regularly, or have CI do it.
To Eric's comment, if you can make that indication in Jira/GitHub then you
can transition that to the script. For example, a "Changelog" label in
github that would mean to have it included.
On Wed, May 17, 2017 at 10:37 AM Eric Friedrich (efriedri) <
efriedri@cisco.com> wrote:
> What about a compromise where developer chooses whether or not a
> feature/important fix is worth mentioning in the release notes. This would
> be at feature granularity not individual commit.
>
> Then at release build time, a script gathers from JIRA/Github API all
> fixes that were committed in that release and checks that into repo.
>
> —Eric
>
> > On May 17, 2017, at 12:18 PM, Phil Sorber <so...@apache.org> 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 <
> Derek_Gelinas@comcast.com>
> > 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 <ne...@apache.org> 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
> >>
>
>
Re: [VOTE] Adding a CHANGELOG.md file
Posted by "Eric Friedrich (efriedri)" <ef...@cisco.com>.
What about a compromise where developer chooses whether or not a feature/important fix is worth mentioning in the release notes. This would be at feature granularity not individual commit.
Then at release build time, a script gathers from JIRA/Github API all fixes that were committed in that release and checks that into repo.
—Eric
> On May 17, 2017, at 12:18 PM, Phil Sorber <so...@apache.org> 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 <De...@comcast.com>
> 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 <ne...@apache.org> 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
>>
Re: [VOTE] Adding a CHANGELOG.md file
Posted by Phil Sorber <so...@apache.org>.
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 <De...@comcast.com>
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 <ne...@apache.org> 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
>
Re: [VOTE] Adding a CHANGELOG.md file
Posted by "Gelinas, Derek" <De...@comcast.com>.
+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 <ne...@apache.org> 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