You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@mnemonic.apache.org by Rakesh Radhakrishnan <ra...@gmail.com> on 2016/04/09 19:24:29 UTC
Maintaining CHANGES.txt file for capturing project change log
Hi All,
I think we need to maintain CHANGES.txt file to capture the change log
details which can be used for a full list of changes in a release. I'm
attaching one sample file with this mail. This can be used and fill the
change log details while committing next change in the project.
*Location of this file:*
master/CHANGES.txt
Thanks,
Rakesh
RE: Maintaining CHANGES.txt file for capturing project change log
Posted by "Zheng, Kai" <ka...@intel.com>.
Agree. Better not to complicate this introducing the extra. For the early major releases, release notes can be manually written to document the great features; later in minor releases, JIRAs can be referenced.
Regards,
Kai
-----Original Message-----
From: Gangumalla, Uma [mailto:uma.gangumalla@intel.com]
Sent: Sunday, April 10, 2016 3:25 AM
To: dev@mnemonic.incubator.apache.org
Subject: Re: Maintaining CHANGES.txt file for capturing project change log
I think Yetus project has a tool to generate release notes from git log itself.
I feel adding one entry for every commit in CHANGES.txt this is unnecessary step.
In recent days we stopped tracking commit details in CHANGES.txt in Hadoop project as well, thinking this is unnecessary and Yetus can generate.
May be until we integrate such tools, we can track CHANGES.txt as temporary solution? This would basically useful for generating Release notes.
Regards,
Uma
From: Rakesh Radhakrishnan <ra...@gmail.com>>
Reply-To: "dev@mnemonic.incubator.apache.org<ma...@mnemonic.incubator.apache.org>" <de...@mnemonic.incubator.apache.org>>
Date: Saturday, April 9, 2016 at 10:24 AM
To: "dev@mnemonic.incubator.apache.org<ma...@mnemonic.incubator.apache.org>" <de...@mnemonic.incubator.apache.org>>
Subject: Maintaining CHANGES.txt file for capturing project change log
Hi All,
I think we need to maintain CHANGES.txt file to capture the change log details which can be used for a full list of changes in a release. I'm attaching one sample file with this mail. This can be used and fill the change log details while committing next change in the project.
Location of this file:
master/CHANGES.txt
Thanks,
Rakesh
Re: Maintaining CHANGES.txt file for capturing project change log
Posted by Gary <ga...@apache.org>.
I agree with all of you, however we'd like to use less efforts to
achieve better quality so after some investigation, I found the Fisheye
that is
/"Visualize and report on activity and search for commits, files,
revisions, or teammates across SVN, Git, Mercurial, CVS and Perforce."
(https://www.atlassian.com/software/fisheye)//
/The Fisheye supports smart commit that is
/
//When you manage your project's repositories in Bitbucket or GitHub, or
use FishEye to browse and search your repositories, you can process your
JIRA Software issues using special commands, called Smart Commits, in
your commit messages.//
//
//You can://
//
// comment on issues//
// record time tracking information against issues//
// transition issues to any status defined in the JIRA Software
project's workflow.//
//(https://confluence.atlassian.com/bitbucket/processing-jira-software-issues-with-smart-commit-messages-298979931.html)//
//
/so Could we request Fisheye product on Mnemonic project like some other
Apache projects did to address those concerns?
Thanks :)
B.R,
+Gary
On 4/9/2016 11:37 PM, Henry Saputra wrote:
> Manual CHANGES.txt is not very useful.
>
> I am proposing big changes or any changes that change existing
> functionalities should be accompanied with JIRA to help manage and track
> changes.
>
> - Henry
>
> On Sat, Apr 9, 2016 at 12:24 PM, Gangumalla, Uma <um...@intel.com>
> wrote:
>
>> I think Yetus project has a tool to generate release notes from git log
>> itself.
>> I feel adding one entry for every commit in CHANGES.txt this is
>> unnecessary step.
>> In recent days we stopped tracking commit details in CHANGES.txt in Hadoop
>> project as well, thinking this is unnecessary and Yetus can generate.
>>
>> May be until we integrate such tools, we can track CHANGES.txt as
>> temporary solution? This would basically useful for generating Release
>> notes.
>>
>> Regards,
>> Uma
>>
>> From: Rakesh Radhakrishnan <rakeshr.apache@gmail.com<mailto:
>> rakeshr.apache@gmail.com>>
>> Reply-To: "dev@mnemonic.incubator.apache.org<mailto:
>> dev@mnemonic.incubator.apache.org>" <dev@mnemonic.incubator.apache.org
>> <ma...@mnemonic.incubator.apache.org>>
>> Date: Saturday, April 9, 2016 at 10:24 AM
>> To: "dev@mnemonic.incubator.apache.org<mailto:
>> dev@mnemonic.incubator.apache.org>" <dev@mnemonic.incubator.apache.org
>> <ma...@mnemonic.incubator.apache.org>>
>> Subject: Maintaining CHANGES.txt file for capturing project change log
>>
>> Hi All,
>>
>> I think we need to maintain CHANGES.txt file to capture the change log
>> details which can be used for a full list of changes in a release. I'm
>> attaching one sample file with this mail. This can be used and fill the
>> change log details while committing next change in the project.
>>
>> Location of this file:
>>
>> master/CHANGES.txt
>>
>> Thanks,
>> Rakesh
>>
Re: Maintaining CHANGES.txt file for capturing project change log
Posted by Henry Saputra <he...@gmail.com>.
Manual CHANGES.txt is not very useful.
I am proposing big changes or any changes that change existing
functionalities should be accompanied with JIRA to help manage and track
changes.
- Henry
On Sat, Apr 9, 2016 at 12:24 PM, Gangumalla, Uma <um...@intel.com>
wrote:
> I think Yetus project has a tool to generate release notes from git log
> itself.
> I feel adding one entry for every commit in CHANGES.txt this is
> unnecessary step.
> In recent days we stopped tracking commit details in CHANGES.txt in Hadoop
> project as well, thinking this is unnecessary and Yetus can generate.
>
> May be until we integrate such tools, we can track CHANGES.txt as
> temporary solution? This would basically useful for generating Release
> notes.
>
> Regards,
> Uma
>
> From: Rakesh Radhakrishnan <rakeshr.apache@gmail.com<mailto:
> rakeshr.apache@gmail.com>>
> Reply-To: "dev@mnemonic.incubator.apache.org<mailto:
> dev@mnemonic.incubator.apache.org>" <dev@mnemonic.incubator.apache.org
> <ma...@mnemonic.incubator.apache.org>>
> Date: Saturday, April 9, 2016 at 10:24 AM
> To: "dev@mnemonic.incubator.apache.org<mailto:
> dev@mnemonic.incubator.apache.org>" <dev@mnemonic.incubator.apache.org
> <ma...@mnemonic.incubator.apache.org>>
> Subject: Maintaining CHANGES.txt file for capturing project change log
>
> Hi All,
>
> I think we need to maintain CHANGES.txt file to capture the change log
> details which can be used for a full list of changes in a release. I'm
> attaching one sample file with this mail. This can be used and fill the
> change log details while committing next change in the project.
>
> Location of this file:
>
> master/CHANGES.txt
>
> Thanks,
> Rakesh
>
Re: Maintaining CHANGES.txt file for capturing project change log
Posted by "Gangumalla, Uma" <um...@intel.com>.
I think Yetus project has a tool to generate release notes from git log itself.
I feel adding one entry for every commit in CHANGES.txt this is unnecessary step.
In recent days we stopped tracking commit details in CHANGES.txt in Hadoop project as well, thinking this is unnecessary and Yetus can generate.
May be until we integrate such tools, we can track CHANGES.txt as temporary solution? This would basically useful for generating Release notes.
Regards,
Uma
From: Rakesh Radhakrishnan <ra...@gmail.com>>
Reply-To: "dev@mnemonic.incubator.apache.org<ma...@mnemonic.incubator.apache.org>" <de...@mnemonic.incubator.apache.org>>
Date: Saturday, April 9, 2016 at 10:24 AM
To: "dev@mnemonic.incubator.apache.org<ma...@mnemonic.incubator.apache.org>" <de...@mnemonic.incubator.apache.org>>
Subject: Maintaining CHANGES.txt file for capturing project change log
Hi All,
I think we need to maintain CHANGES.txt file to capture the change log details which can be used for a full list of changes in a release. I'm attaching one sample file with this mail. This can be used and fill the change log details while committing next change in the project.
Location of this file:
master/CHANGES.txt
Thanks,
Rakesh