Hi Glen,
there are two different options
1) maintain changes.xml manually
2) create the changes.xml directly from JIRA
Unfortunately I never got 2) to work - having said that I would like to
re-ask the question - "how do I ensure that a contributor's name show up
on project?". I know it sounds a bit odd but I'm also helping out with
Hackergarden events and one thing I want to ensure is public visibility
of these events. Contributers are rightly proud if the helped out on an
ASF project ... ;-)
Cheers,
Siegfried Goeschl
On 26.01.13 21:51, Glen Mazza wrote:
Hmm, I see:
http://svn.apache.org/viewvc/commons/proper/email/trunk/src/changes/changes.xml?view=log
and
http://svn.apache.org/viewvc/commons/proper/email/trunk/pom.xml?revision=1434776&view=markup#l327
I like changes.xml more because it has a structure to it--moving to this
might be better after we Mavenize (however, might not help us so much
because the technology we use to generate our website wouldn't directly
create a website page for us like it does for Commons Email.) Still,
most Apache projects AFAICT don't bother anymore with change files, but
as long as it's useful for at least some team members I'm OK with it.
Questions, Siegfried: how is the above changes.xml created, it is
completely manual or partly autogenerated from JIRA (I'm assuming the
former)? Also, is one required to open up a JIRA every time someone
makes a change to the source code, or that's not a strict requirement?
I know CXF relies on JIRA alone for the release notes: The website
release notes link ( http://cxf.apache.org/cxf-272-release-notes.html)
has people go directly to JIRA for a list:
https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12310511&styleName=Html&Create=Create&version=12323604
As for naming team members, Apache Syncope and Commons Email apparently
both keep that info in their pom.xml (like they do the mailing address
info):
http://svn.apache.org/viewvc/syncope/trunk/pom.xml?revision=1438506&view=markup#l114
http://svn.apache.org/viewvc/commons/proper/email/trunk/pom.xml?revision=1434776&view=markup
...which automatically populates their Team page (and mailing list page)
when they generate their website:
http://syncope.apache.org/team-list.html (out-of-sync right now as they
are waiting for a new release before republishing their website).
http://commons.apache.org/email/team-list.html
However, this of course wouldn't be applicable for us yet because we're
not yet on Maven (I'm trying, I'm trying... :) and we again use a
different technology from Commons Email or Syncope in generating our
website.
Thanks for the info,
Glen
On 01/26/2013 03:07 PM, Siegfried Goeschl wrote:
Hi folks,
I would suggest to move the content into a "changes.xml" which is the
input of a HTML report when the site is generated (using Maven). It is
also a good place to name contributors ... :-). It can be also used to
generate parts of the release notes.
Check out
http://commons.apache.org/email/changes-report.html
Cheers,
Siegfried Goeschl
On 26.01.13 11:55, Harry Metske 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 <[email protected]> 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
