Opened 9 years ago

Last modified 7 years ago

#261 new task

clean up noisy trac notification emails

Reported by: maphew Owned by: osgeo4w-dev@…
Priority: major Component: Website
Version: Keywords:
Cc:

Description

The email notifications from the tracker are noisier than they need to be. Every tac notification body begins with header of ticket properties (reporter, type, priority, etc). These properties rarely change so we don't need to have them flashed at us with every ticket update. The most relevant information what's new and changed, is what we want to see first.

Fortunately the templating system gives enough flexibility to present things differently. Let's move the rarely changing items to the bottom of the message (or not include them at all, as the definitive record is the website anyway).

Here is a current sample notification from a ticket comment being added. Note that the info of interest doesn't start until line 9.

#162: pythonwin launcher
--------------------------+-------------------------------------------------
Reporter:  wildintellect  |       Owner:  osgeo4w-dev@…              
    Type:  enhancement    |      Status:  new                        
Priority:  major          |   Component:  Package                    
 Version:  1.0            |    Keywords:  python pythonwin          
--------------------------+------------------------------------------------- 

Comment(by maphew):

 I put together a version of [pkg-python-win32] which creates desktop and
 ...

Here is a presentation that moves the most relevant information to the top:

#162: pythonwin launcher
Ticket URL: <http://trac.osgeo.org/osgeo4w/ticket/162#comment:3> 

Comment(by maphew):

 I put together a version of [pkg-python-win32] which creates desktop and
 ...
 ...
 ...

--------------------------+-------------------------------------------------
Reporter:  wildintellect  |       Owner:  osgeo4w-dev@…              
    Type:  enhancement    |      Status:  new                        
Priority:  major          |   Component:  Package                    
 Version:  1.0            |    Keywords:  python pythonwin          
--------------------------+------------------------------------------------- 
OSGeo4W <http://trac.osgeo.org/osgeo4w>
OSGeo4W is the Windows installer and package environment for the OSGeo stack. 

And this is the template modification that enables it, a very simple modification of the default (only 4 lines changed).

$ticket_body_hdr
Ticket URL: <$ticket.link>
#choose ticket.new
  #when True
$ticket_props  # moved here from line 3
$ticket.description
  #end
  #otherwise
    #if changes_body
Changes (by $change.author):
...
...
...
--
$ticket_props  # repeated, but only on new tickets.
Ticket URL: <$ticket.link>
$project.name <${project.url or abs_href()}>
$project.descr

New tickets will remain mostly as they are now, reporting the properties at the beginning of the message, and then repeated again in the footer. So there is some duplication, but given the position I think it acceptable. (Someone more familiar with Genshi templates could figure out how to avoid the duplication if it is really desired).

Change History (1)

comment:1 Changed 7 years ago by jef

Who can do that? Isn't that a job for SAC?

Note: See TracTickets for help on using tickets.