Re: svn commit: r345273 - /maven/site/trunk/src/site/apt/guides/mini/guide-releasing.apt

[Jason van Zyl <ja...@maven.org>]

On Fri, 2005-11-18 at 10:59 +1100, Brett Porter wrote:
> Please use the template...
> 
> I know its mostly in the commit, but I'd like to see issue # (not URL, 
> as I'm not sure that triggers the subversion commits in JIRA), submitter 
> and a summary so svn log/view history works.

I've tried to relieve the tedium and try to provide more accurate and
useful information for the history and easier linking of information. To
that end there is now a little script here:

http://svn.apache.org/viewcvs.cgi/maven/sandbox/issue/rissue/cm?
rev=345490&view=markup

You'll need the 'jira4r' library there as well. 

Using Jesse's suggestion if you are in vi you can do:

:r ! cm MNG-100

And the issue information will pop up.

Not sure how Windows folks would do this but it was fun to do. Maybe
I'll whip off a python version for fun too :-)

> - Brett
> 
> jvanzyl@apache.org wrote:
> > Author: jvanzyl
> > Date: Thu Nov 17 08:02:49 2005
> > New Revision: 345273
> > 
> > URL: http://svn.apache.org/viewcvs?rev=345273&view=rev
> > Log:
> > o http://jira.codehaus.org/browse/MNG-1564
> > 
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> For additional commands, e-mail: dev-help@maven.apache.org
> 
> 
-- 
jvz.

Jason van Zyl
jason at maven.org
http://maven.apache.org

believe nothing, no matter where you read it,
or who has said it,
not even if i have said it,
unless it agrees with your own reason
and your own common sense.

 -- Buddha


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org

Re: svn commit: r345273 - /maven/site/trunk/src/site/apt/guides/mini/guide-releasing.apt

[Jason van Zyl <ja...@maven.org>]

On Sun, 2005-11-20 at 10:06 +1100, Brett Porter wrote:
> Jason van Zyl wrote:
> > I've tried to relieve the tedium and try to provide more accurate and
> > useful information for the history and easier linking of information. To
> > that end there is now a little script here:
> 
> That's great - I'll try it out.
> 
> Can we agree on a template? I notice they you are doing a couple of 
> things that still get annoying for me:
> - the horizontal lines which are not fun to type without the tool, and 
> which clutter the svn log command output which also uses horizontal 
> lines. I'm sure it will also look a bit much in the changelog report

That's no problem, I was just reusing the format the JIRA spot spits out
and I was just giving it a whirl. It's definitely a bit much and easy to
remove.

> - the URL: its easy enough to paste the issue in to the search box of an 
> already open jira window, and the URLs are likely to rot 
> (jira.werken.com -> jira.codehaus.org -> jira.wheredowegonext.org)

When I was playing around I just found it convenient when spitting out
the history to just be able to jump to the issue. I imagine the same
would be true in a generated changelog. The URLs may rot, but for the
most part I don't think it can hurt and at the very least can be
optional. I found it handy myself to jump from email right to the issue.

> I thought we'd decided, and its documented here:
> http://maven.apache.org/guides/development/guide-m2-development.html#Commit%20Message%20Template

Sure, but I think that can be adjusted to allow for richer information
if it's available. I'm just trying to provide better navigation when the
information is available. I like seeing the URL and the description as
it provides an easier way to navigate and an easier way to understand
what you're looking at.

I can easily change to use PR and Submitter, though it is nice to see
the reporter as well even when there isn't a patch suppled (and usually
they are the same when a patch is supplied). It would be nice to have
their email at hand but I refrained from adding it because of the spam
potential.

That said I will try to get it wired in on the server side so it's
convenient and provides a richer set of information for which there are
any number of possibilities.

-- 
jvz.

Jason van Zyl
jason at maven.org
http://maven.apache.org

believe nothing, no matter where you read it,
or who has said it,
not even if i have said it,
unless it agrees with your own reason
and your own common sense.

 -- Buddha


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org

Re: svn commit: r345273 - /maven/site/trunk/src/site/apt/guides/mini/guide-releasing.apt

[Brett Porter <br...@apache.org>]

Jason van Zyl wrote:
> I've tried to relieve the tedium and try to provide more accurate and
> useful information for the history and easier linking of information. To
> that end there is now a little script here:

That's great - I'll try it out.

Can we agree on a template? I notice they you are doing a couple of 
things that still get annoying for me:
- the horizontal lines which are not fun to type without the tool, and 
which clutter the svn log command output which also uses horizontal 
lines. I'm sure it will also look a bit much in the changelog report
- the URL: its easy enough to paste the issue in to the search box of an 
already open jira window, and the URLs are likely to rot 
(jira.werken.com -> jira.codehaus.org -> jira.wheredowegonext.org)

Remember, not everyone will be using the tool (eg, I mostly commit using 
IDEA), and the current template has only the "PR:\nSubmitted by:" boiler 
plate which is not much typing (and admittedly often there from the last 
commit).

I thought we'd decided, and its documented here:
http://maven.apache.org/guides/development/guide-m2-development.html#Commit%20Message%20Template

I know I'm annoyingly picky about this, just humour me.

- Brett

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org