Hi,

the ChangeLog shows the lists of "versions", being a "version" something
similar to a (i.e.) Jenkins release (except that in Jenkins new release =
new war), that is, a bunch of new functionality, which may comprise one or
several commits. In the latter case, the Changelog file comes in handy.

If a new functionality is added, the release number in
org.apache.wiki.Release gets bumped and the ChangeLog file is updated with
the appropiate info. Similarly a commit may not be itself worth a
"version", i.e.: a commit to omit some auto-generated files. What
constitutes a "version" and what not is left to the committer; as they're
cheap to generate it isn't a big deal.

Related to ChangeLog, and having mentioned Jenkins, I've just noticed that
the ChangeLog file is very close to Markdown syntax, so we could use it to
generate a $svn/site/trunk/content/jspwiki/development/changelog.mdtext
That would make the contributors' names a lot more visible.

A first step would have some kind of JUnit (or whatever), similar to
TranslationsCheck, to generate the appropiate file. Then this change would
also be committed and then published (this could be done automatically by a
Jenkins post-job @ builds.a.o). Hmmm and we could also refresh the version
displayed @ i.a.o/jspwiki, and also publish another page with the different
translation statuses..

thoughts?


br,
juan pablo

On Mon, Jan 28, 2013 at 3:16 AM, Ichiro Furusato
<ichiro.furus...@gmail.com>wrote:

> [-1]
>
> I'm not a committer so I don't get a vote, but FWIW I've always preferred
> human-managed change logs, since that means a human being is highlighting
> the more important changes, new or changed APIs, features, etc. whereas
> the machine-generated ones force me to slog through *all* of the changes.
>
> Yes, it does require some overhead but it's very helpful for co-developers.
>
> Ichiro
>
> On Sat, Jan 26, 2013 at 11:55 PM, Harry Metske <harry.met...@gmail.com>
> wrote:
> > -0.5
> >
> > I have always found this Changelog a very convenient mechanism of
> searching
> > for "what has changed when in what version".
> > You have it one file, easily searchable and scrollable.
> > The overhead is minimal, always cut/paste the Changelog update to the
> > commit log.
> > I agree that mentioned links provide all information (and more), but not
> so
> > easy to search, you always have to click a hundred times before you find
> > what you want.
> >
> > kind regards,
> > Harry
> >
> >
> > On 25 January 2013 03:29, Glen Mazza <glen.ma...@gmail.com> wrote:
> >
> >> Hi team, we have a "ChangeLog" file in the root folder that is
> apparently
> >> (?) updated whenever someone makes a commit.  I don't see a need for it,
> >> and none of the other Apache projects I'm aware of bothers with such a
> file
> >> -- it's annoying needing to update it and it just seems to be
> unnecessary
> >> overhead.  Can we get rid of it?
> >>
> >> So long as you make comments when you commit, here is a 100.0%
> >> authoritative and chronological list of all commits made and what they
> >> involve:
> >> http://mail-archives.apache.**org/mod_mbox/incubator-**
> >> jspwiki-commits/201301.mbox/**browser<
> http://mail-archives.apache.org/mod_mbox/incubator-jspwiki-commits/201301.mbox/browser
> >
> >>
> >> And of course the SVN repository details the changes made to each
> specific
> >> file fully and accurately:
> >> http://svn.apache.org/viewvc/**incubator/jspwiki/trunk/src/**
> >> webdocs/Error.jsp?view=log<
> http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/webdocs/Error.jsp?view=log
> >
> >>
> >> Finally, JIRA nicely provides us a list of commits per release:
> >> https://issues.apache.org/**jira/browse/JSPWIKI#**
> >>
> selectedTab=com.atlassian.**jira.plugin.system.project%**3Achangelog-panel<
> https://issues.apache.org/jira/browse/JSPWIKI#selectedTab=com.atlassian.jira.plugin.system.project%3Achangelog-panel
> >
> >>
> >> That should be good enough for us.  WDYT?
> >>
> >> Regards,
> >> Glen
> >>
>

Reply via email to