Re: [DISCUSSION] More convenient way to maintain committer / contributor list and changelogs

[Jungtaek Lim <ka...@gmail.com>]

This thread was forgotten, but it seems that some of us want to change the
way what we're doing.

Do we need VOTE for this? Or is it OK to assume that we're in consensus and
go forward?

Btw, we can extract contributor lists from codebase if we want to keep it
as is.

git log --pretty=format:'%an' | sort -u
(borrowed from OpenTSDB/AsyncBase)

I even think mentioning contributors for each release news is more
honorable compared to just listing up with README forever. There's also
contributors tab in Github so we could even get rid of it.

Thanks,
Jungtaek Lim (HeartSaVioR)

2016년 1월 21일 (목) 오후 11:59, Bobby Evans <ev...@yahoo-inc.com.invalid>님이 작성:

> I totally agree. I just filed
> https://issues.apache.org/jira/browse/STORM-1490 to improve our process
> to make that script.
>
> I have no idea when I will get around to it, but I assigned it to myself
> as a start.  If someone else wants to take a crack at it, I am fine with
> that.  I know spark has something like this already that we might be able
> to use as an example.
>  - Bobby
>
>     On Wednesday, January 20, 2016 5:19 PM, Jungtaek Lim <
> kabhwan@gmail.com> wrote:
>
>
>  Sorry I also have forgotten this, since I was on vacation by chance.
>
> I'm handling backport of some pull requests, and I STRONGLY think we should
> come up better way to handle CHANGELOG.md.
> It is easy to be diverged between version branches, and now it is.
>
> I agree we can include automation of modifying README / CHANGELOG to our
> release process.
> Squashing commits in pull request into one, like Zeppelin could help us
> automating this work since referencing commit history is more accurate than
> referencing JIRA issue.
>
> But if we want to modify CHANGELOG as soon as issue is resolved, we can
> move CHANGELOG to asf-site and modify it.
> (Precondition: website should reflect asf-site branch of git repo. Would I
> file an issue to asf infra?)
> Maintaining wiki page is an alternative way. It is easier to edit but it
> requires login/open/edit/close the page so CLI lover may not like it.
>
> Hope we can change the way to work pragmatically.
>
> Thanks,
> Jungtaek Lim (HeartSaVioR)
>
> 2016년 1월 9일 (토) 오전 1:11, Bobby Evans <ev...@yahoo-inc.com.invalid>님이 작성:
>
> > This took a while for me to get to this, but they look really good.  We
> > may want to tweak a few things, but overall I think we should look at
> > including this in our release process.
> >  - Bobby
> >
> >    On Monday, December 7, 2015 5:54 PM, Haohui Mai <ri...@gmail.com>
> > wrote:
> >
> >
> >  Just ran
> >
> https://raw.githubusercontent.com/apache/yetus/master/release-doc-maker/releasedocmaker.py
> > against STORM.
> >
> > It generates CHANGES and RELEASENOTES automatically. Do they look
> > good? It is also possible to tailor the script for STORM as well.
> >
> > ~Haohui
> >
> >
> >
> > On Wed, Dec 2, 2015 at 5:03 PM, 임정택 <ka...@gmail.com> wrote:
> > > Yeah, that would be good.
> > > (Taylor, did you mean that we'd be better to move CHANGELOG.md to
> > official
> > > site?)
> > >
> > > If we decide to maintain it from asf-site branch, I think preconditions
> > > should be met in order to let us feel more convenient than current.
> > >
> > >    - Pushing to asf-site branch via git repo should update our official
> > >    site.
> > >    - Yaml files should be updated automatically.
> > >      - Because pushing to asf-site requires checking out asf-site
> branch,
> > >      modifying yaml files, and pushing to remote, and checking out
> > > master branch
> > >      again.
> > >
> > > I'm curious we can resolve preconditions, at least first one.
> > > Any updates on this, Taylor?
> > >
> > > Any other opinions are appreciated!
> > >
> > > - Jungtaek Lim (HeartSaVioR)
> > >
> > > ps. Btw, if we decide to scan jira issue and create CHANGELOG, how
> about
> > > adding assignee to CHANGELOG so that anyone can see huge
> > > contributors easily?
> > >
> > > 2015-12-03 9:35 GMT+09:00 P. Taylor Goetz <pt...@gmail.com>:
> > >
> > >> IMHO we should take that out of the readme, and maintain it as part of
> > the
> > >> website. Better yet, automate it as haohui suggested.
> > >>
> > >> In the website branch in git we now have a yaml file that contains all
> > >> that information. I'd rather maintain it there, in one place, and
> > automate
> > >> if we can.
> > >>
> > >> -Taylor
> > >>
> > >> > On Dec 2, 2015, at 6:06 PM, 임정택 <ka...@gmail.com> wrote:
> > >> >
> > >> > Hi all,
> > >> >
> > >> > Apache Storm project maintains committer / contributor list to
> > >> > README.markdown
> > >> > <https://github.com/apache/storm/blob/master/README.markdown> and
> > >> resolved
> > >> > JIRA issues to CHANGELOG.md
> > >> > <https://github.com/apache/storm/blob/master/CHANGELOG.md>.
> > >> > And recently we're adding the page "People" to official web site,
> > >> > http://storm.apache.org/contribute/People.html, which seems not be
> > >> updated
> > >> > already.
> > >> >
> > >> > Since we occasionally missed to add those things, it would be better
> > to
> > >> > have more convenient way to record.
> > >> > For now updating "People" seems annoying since we should update site
> > via
> > >> > applying patch and committing to SVN repo.
> > >> > Do we feel that is it convenient to maintain these to git repo? Are
> > there
> > >> > more convenient ways to maintain? Could WIKI be more convenient way?
> > >> >
> > >> > Thanks,
> > >> > Jungtaek Lim (HeartSaVioR)
> > >>
> > >
> > >
> > >
> > > --
> > > Name : 임 정택
> > > Blog : http://www.heartsavior.net / http://dev.heartsavior.net
> > > Twitter : http://twitter.com/heartsavior
> > > LinkedIn : http://www.linkedin.com/in/heartsavior
> >
> >
>
>