Edgewall Software

Changes between Version 21 and Version 22 of CommitTicketUpdater


Ignore:
Timestamp:
Aug 31, 2016, 10:58:05 PM (22 months ago)
Author:
figaro
Comment:

Further cosmetic changes

Legend:

Unmodified
Added
Removed
Modified
  • CommitTicketUpdater

    v21 v22  
    1616== Location
    1717
    18 The `CommitTicketUpdater` component lives in [source:trunk/tracopt/ticket/commit_updater.py commit_updater.py] and is maintained alongside the Trac core. It's included with every Trac installation as a plugin, but is not enabled by default because it's rooted in the `tracopt.` packages and not in `trac.`.  Therefore it needs to be explicitly activated through the Admin interface.
     18The `CommitTicketUpdater` component lives in [source:trunk/tracopt/ticket/commit_updater.py commit_updater.py] and is maintained alongside the Trac core. It's included with every Trac installation as a plugin, but is not enabled by default because it's rooted in the `tracopt.` packages and not in `trac.`. Therefore it needs to be explicitly activated through the Admin interface.
    1919
    2020== Enable
     
    2323    a. !CommitTicketUpdater (tracopt.ticket.commit_updater.*)
    2424    b. !CommitTicketReferenceMacro (tracopt.ticket.commit_updater.*)
    25  1. Alternatively edit the `trac.ini` file, add the following line at the `[components]` section:
    26 {{{
     25 1. Alternatively edit the `trac.ini` file, by adding the following line in the `[components]` section:
     26{{{#!ini
     27[components]
    2728tracopt.ticket.commit_updater.* = enabled
    2829}}}
    2930
    30 == Configure
     31== Configuration
    3132
    32 {{{
     33There are also the following configurations to be set in the `trac.ini` file:
     34{{{#!ini
    3335[ticket]
    3436commit_ticket_update_envelope = []
     
    3941}}}
    4042
    41 Where,
     43Where:
    4244 * `commit_ticket_update_envelope` sets the required commands to be enclosed in an envelope.
    4345     * Must be empty not to require an envelope;
    44      * or contain two characters. For example, if set to "[]", then commands must be in the form of `[closes #4]`.[[BR]][[BR]]
     46     * or contain two characters. For example, if set to "[]", then commands must be in the form of `[closes #4]`.
     47
    4548 * `commit_ticket_update_commands.close`: has a space-separated list, with commands that close tickets.
    46     * Default values to **close** a ticket: //close closed closes fix fixed fixes// [[BR]][[BR]]
     49    * Default values to **close** a ticket: //close closed closes fix fixed fixes//
     50
    4751 * `commit_ticket_update_commands.refs`: has a space-separated list, with commands that add a reference to tickets.
    4852    * Default values to **reference** a ticket: //addresses re references refs see//
    49     * If set to the special value //<ALL>//, all tickets referenced by the message will get a reference to the changeset.[[BR]][[BR]]
     53    * If set to the special value //<ALL>//, all tickets referenced by the message will get a reference to the changeset.
     54
    5055 * `commit_ticket_update_check_perms` when //true// checks that the committer has permission to perform the requested operations on the referenced tickets
    51     * Values: //true//, //false//[[BR]][[BR]]
     56    * Values: //true//, //false//
     57
    5258 * `commit_ticket_update_notify`, when //true// send ticket change notification when updating a ticket.
    5359    * Values: //true//, //false//
     
    6773The basic syntax is of the form `[command] [ticketreference]`. A colon between the command and the ticket reference is allowed. The `ticketreference` also allows to list //multiple// ticket numbers separated by spaces and/or comma. The word 'and' is also allowed between ticket numbers.
    6874
    69 You can optionally refer to tickets with the following words
     75You can optionally refer to tickets with the following words:
    7076* //ticket//, //issue//, //bug//
    7177