Changes between Version 48 and Version 49 of TracCronPlugin


Ignore:
Timestamp:
Jan 17, 2016, 4:31:57 PM (8 years ago)
Author:
figaro
Comment:

Cosmetic changes, tagged with pypi

Legend:

Unmodified
Added
Removed
Modified
  • TracCronPlugin

    v48 v49  
    1111 * Bundled out-of-the-box task
    1212 * Scheduler are plugin
    13  * Bundled out-of-the-box scheduler '''new''' ''cron syntax is supported''
     13 * Bundled out-of-the-box scheduler; '''new''': cron syntax is supported
    1414 * Listener mechanism to be notified of task execution
    15  * Bundled out-of-the-box listener '''new''' ''admin panel for listener''
    16  * Task execution history '''new''' ''rss feed is available''
     15 * Bundled out-of-the-box listener; '''new''': admin panel for listener
     16 * Task execution history; '''new''': rss feed is available
    1717
    1818The plugin provides an administration panel to help with scheduling:
     
    3131
    3232Current stable release is '''0.3.1'''.
     33
    3334You can use easy_install or pip to download and install the latest package into your Python environment:
    3435{{{#!sh
     
    117118
    118119The plugin can be entirely configured from either trac.ini or the administration panel.
    119 The section name of TracCronPlugin is traccron, here is a full sample:
     120The section name of TracCronPlugin is `traccron`, here is a full sample:
    120121
    121122{{{#!ini
     
    137138=== Global settings
    138139
    139 This control the object called ticker which is the thread that launches tasks. If False, no ticket (no thread) is created, so your Trac behaves like there is no cron installed. This is the global setting you can act on to enable or disable all tasks. Default value is '''True''':
     140This controls the object called ticker, which is the thread that launches tasks. If False, no ticket (no thread) is created, so your Trac behaves like there is no cron installed. This is the global setting you can act on to enable or disable all tasks. Default value is '''True''':
    140141
    141142{{{#!ini
     
    175176}}}
    176177
    177 This scheduler triggers a task that needs to be executed once a month. Provide the day in month and the hour when the task will be launched. The day is the index of the day starting at 1. Accepts comma separated value. Default is no value:
     178This scheduler triggers a task that needs to be executed once a month. Provide the day in month and the hour when the task will be launched. The day is the index of the day starting at 1. Accepts comma separated values. Default is no value:
    178179
    179180{{{#!ini
     
    214215
    215216This task reminds the reporter about orphaned tickets and the assigned user about sleeping tickets.
    216  * An orphaned ticket is a ticket with status New since more than a given amount of days. An email notification is sent to the reporter in such a case.
    217  * A sleeping ticket is a ticket assigned to an user, but the user either did not accept it or did not touch the ticket (add a comment for example) since more than a given amount of day. The assigned user is notified in such a case.
     217 * An orphaned ticket is a ticket with status New for more than a given amount of days. An email notification is sent to the reporter in such a case.
     218 * A sleeping ticket is a ticket assigned to a user, but the user either did not accept it or did not touch the ticket (added a comment for example) for more than a given amount of days. The assigned user is notified in such a case.
    218219
    219220The delay is an optional parameter associated with each schedule. Default value is '''3 days'''.
     
    223224'''Note''': Since 0.2dev_r9388
    224225
    225 This task scan still opened tickets in near milestone. Such a situation means that those tickets will probably not be part of the milestone. The task sends a mail to user defined with ''unreachable_milestone.recipient'' (default is '''empty''') for each milestone with the list of still opened tickets. You may want to set the value to the release manager user. Reporter and owner are notified too, but only for their tickets. The task looks for the nearest milestone until '''3 days ahead'''. You can change the value with parameter either by setting ''unreachable_milestone.<schedule>.arg'' or in admin panel.
     226This task scans still opened tickets in near milestone. Such a situation means that those tickets will probably not be part of the milestone. The task sends a mail to user defined with ''unreachable_milestone.recipient'' (default is '''empty''') for each milestone with the list of still opened tickets. You may want to set the value to the release manager user. Reporter and owner are notified too, but only for their tickets. The task looks for the nearest milestone until '''3 days ahead'''. You can change the value with parameter either by setting ''unreachable_milestone.<schedule>.arg'' or in the admin panel.
    226227
    227228This is an example of the mail for release manager:
     
    255256'''Note''': since 0.2dev_r9390.
    256257
    257 Trac allows the administrator to postpone still opened ticket in a given milestone when he closes this milestone. But this is not mandatory. The auto postpone task will help to not forget opened tickets in closed milestone. The task look for such tickets and postpone them in the more recent still opened milestone. Milestone must have a due date.
     258Trac allows the administrator to postpone still opened ticket in a given milestone when he closes this milestone. But this is not mandatory. The auto postpone task will help to not forget opened tickets in a closed milestone. The task looks for such tickets and postpones them in the more recent still opened milestone. Milestone must have a due date.
    258259
    259260=== Ticket deadline task
     
    261262'''Note''': since 0.3.
    262263
    263 This task notifies to the ticket's reporter and owner when its ticket is near the deadline as a custom field. You can add a date field for ticket using [http://trac-hacks.org/wiki/DateFieldPlugin DateFieldPlugin]. Besides scheduler settings, there are the following options to configure when DateFieldPlugin is used:
     264This task notifies to the ticket's reporter and owner when its ticket is near the deadline as a custom field. You can add a date field for ticket using the DateFieldPlugin. Besides scheduler settings, there are the following options to configure when the DateFieldPlugin is used:
    264265
    265266 - days_before: notify days before the deadline
     
    269270[[Image(ticket-with-duedate.png)]]
    270271
    271 Here is a sample configuration for trac.ini:
     272Here is a sample configuration for the `trac.ini` file:
    272273
    273274{{{#!ini