You are viewing a plain text version of this content. The canonical link for it is here.
Posted to common-dev@hadoop.apache.org by Yongjun Zhang <yz...@cloudera.com> on 2015/03/13 22:49:28 UTC
about CHANGES.txt
Hi,
I found that changing CHANGES.txt when committing a jira is error prone
because of the different sections in the file, and sometimes we forget
about changing this file.
After all, git log would indicate the history of a branch. I wonder if we
could switch to a new method:
1. When committing, ensure the message include the type of the jira, "New
Feature", "Bug Fixes", "Improvement" etc.
2. No longer need to make changes to CHANGES.txt for each commit
3. Before releasing a branch, create the CHANGES.txt by using "git log"
command for the given branch..
Thanks.
--Yongjun
Re: about CHANGES.txt
Posted by Allen Wittenauer <aw...@altiscale.com>.
I think the general consensus is don’t include the changes.txt file in your commit. It won’t be correct for both branches if such a commit is destined for both. (No, the two branches aren’t the same.)
No, git log isn’t more accurate. The problems are:
a) cherry picks
b) branch mergers
c) “whoops i missed something in that previous commit”
d) no identification of what type of commit it was without hooking into JIRA anyway.
This is why I prefer building the change log from JIRA. We already build release notes from JIRA, BTW. (Not that anyone appears to read them given the low quality of our notes…) Anyway, here’s what I’ve been building/using as changes.txt and release notes:
https://github.com/aw-altiscale/hadoop-release-metadata
I try to update these every day. :)
On Mar 13, 2015, at 4:07 PM, Yongjun Zhang <yz...@cloudera.com> wrote:
> Thanks Esteban, I assume this report gets info purely from the jira
> database, but not "git log" of a branch, right?
>
> I hope we get the info from "git log" of a release branch because that'd be
> more accurate.
>
> --Yongjun
>
> On Fri, Mar 13, 2015 at 3:11 PM, Esteban Gutierrez <es...@cloudera.com>
> wrote:
>
>> JIRA already provides a report:
>>
>>
>> https://issues.apache.org/jira/secure/ReleaseNote.jspa?version=12327179&styleName=Html&projectId=12310240
>>
>>
>> cheers,
>> esteban.
>>
>>
>>
>>
>> --
>> Cloudera, Inc.
>>
>>
>> On Fri, Mar 13, 2015 at 3:01 PM, Sean Busbey <bu...@cloudera.com> wrote:
>>
>>> So long as you include the issue number, you can automate pulling the
>> type
>>> from jira directly instead of putting it in the message.
>>>
>>> On Fri, Mar 13, 2015 at 4:49 PM, Yongjun Zhang <yz...@cloudera.com>
>>> wrote:
>>>
>>>> Hi,
>>>>
>>>> I found that changing CHANGES.txt when committing a jira is error prone
>>>> because of the different sections in the file, and sometimes we forget
>>>> about changing this file.
>>>>
>>>> After all, git log would indicate the history of a branch. I wonder if
>> we
>>>> could switch to a new method:
>>>>
>>>> 1. When committing, ensure the message include the type of the jira,
>> "New
>>>> Feature", "Bug Fixes", "Improvement" etc.
>>>>
>>>> 2. No longer need to make changes to CHANGES.txt for each commit
>>>>
>>>> 3. Before releasing a branch, create the CHANGES.txt by using "git log"
>>>> command for the given branch..
>>>>
>>>> Thanks.
>>>>
>>>> --Yongjun
>>>>
>>>
>>>
>>>
>>> --
>>> Sean
>>>
>>
Re: about CHANGES.txt
Posted by Yongjun Zhang <yz...@cloudera.com>.
Thanks Esteban, I assume this report gets info purely from the jira
database, but not "git log" of a branch, right?
I hope we get the info from "git log" of a release branch because that'd be
more accurate.
--Yongjun
On Fri, Mar 13, 2015 at 3:11 PM, Esteban Gutierrez <es...@cloudera.com>
wrote:
> JIRA already provides a report:
>
>
> https://issues.apache.org/jira/secure/ReleaseNote.jspa?version=12327179&styleName=Html&projectId=12310240
>
>
> cheers,
> esteban.
>
>
>
>
> --
> Cloudera, Inc.
>
>
> On Fri, Mar 13, 2015 at 3:01 PM, Sean Busbey <bu...@cloudera.com> wrote:
>
> > So long as you include the issue number, you can automate pulling the
> type
> > from jira directly instead of putting it in the message.
> >
> > On Fri, Mar 13, 2015 at 4:49 PM, Yongjun Zhang <yz...@cloudera.com>
> > wrote:
> >
> > > Hi,
> > >
> > > I found that changing CHANGES.txt when committing a jira is error prone
> > > because of the different sections in the file, and sometimes we forget
> > > about changing this file.
> > >
> > > After all, git log would indicate the history of a branch. I wonder if
> we
> > > could switch to a new method:
> > >
> > > 1. When committing, ensure the message include the type of the jira,
> "New
> > > Feature", "Bug Fixes", "Improvement" etc.
> > >
> > > 2. No longer need to make changes to CHANGES.txt for each commit
> > >
> > > 3. Before releasing a branch, create the CHANGES.txt by using "git log"
> > > command for the given branch..
> > >
> > > Thanks.
> > >
> > > --Yongjun
> > >
> >
> >
> >
> > --
> > Sean
> >
>
Re: about CHANGES.txt
Posted by Esteban Gutierrez <es...@cloudera.com>.
JIRA already provides a report:
https://issues.apache.org/jira/secure/ReleaseNote.jspa?version=12327179&styleName=Html&projectId=12310240
cheers,
esteban.
--
Cloudera, Inc.
On Fri, Mar 13, 2015 at 3:01 PM, Sean Busbey <bu...@cloudera.com> wrote:
> So long as you include the issue number, you can automate pulling the type
> from jira directly instead of putting it in the message.
>
> On Fri, Mar 13, 2015 at 4:49 PM, Yongjun Zhang <yz...@cloudera.com>
> wrote:
>
> > Hi,
> >
> > I found that changing CHANGES.txt when committing a jira is error prone
> > because of the different sections in the file, and sometimes we forget
> > about changing this file.
> >
> > After all, git log would indicate the history of a branch. I wonder if we
> > could switch to a new method:
> >
> > 1. When committing, ensure the message include the type of the jira, "New
> > Feature", "Bug Fixes", "Improvement" etc.
> >
> > 2. No longer need to make changes to CHANGES.txt for each commit
> >
> > 3. Before releasing a branch, create the CHANGES.txt by using "git log"
> > command for the given branch..
> >
> > Thanks.
> >
> > --Yongjun
> >
>
>
>
> --
> Sean
>
Re: about CHANGES.txt
Posted by Sean Busbey <bu...@cloudera.com>.
So long as you include the issue number, you can automate pulling the type
from jira directly instead of putting it in the message.
On Fri, Mar 13, 2015 at 4:49 PM, Yongjun Zhang <yz...@cloudera.com> wrote:
> Hi,
>
> I found that changing CHANGES.txt when committing a jira is error prone
> because of the different sections in the file, and sometimes we forget
> about changing this file.
>
> After all, git log would indicate the history of a branch. I wonder if we
> could switch to a new method:
>
> 1. When committing, ensure the message include the type of the jira, "New
> Feature", "Bug Fixes", "Improvement" etc.
>
> 2. No longer need to make changes to CHANGES.txt for each commit
>
> 3. Before releasing a branch, create the CHANGES.txt by using "git log"
> command for the given branch..
>
> Thanks.
>
> --Yongjun
>
--
Sean