Mercurial > p > roundup > code
comparison scripts/notify-roundup/doc/README @ 4161:8b381ee4e15e gsoc-2009
Check-in first revision of how-to document
| author | Pygi <pygi@users.sourceforge.net> |
|---|---|
| date | Thu, 02 Jul 2009 14:40:09 +0000 |
| parents | |
| children |
comparison
equal
deleted
inserted
replaced
| 4160:7acbd69a0aa0 | 4161:8b381ee4e15e |
|---|---|
| 1 Roundup devel tracker in love with subversion | |
| 2 ============================================= | |
| 3 | |
| 4 This document serves a tutorial on setting up a Roundup instance | |
| 5 with devel template featuring subversion integration. Several assumptions | |
| 6 are made in this tutorial: | |
| 7 | |
| 8 1) You've checked out gsoc-2009 Roundup branch | |
| 9 2) You know how to setup subversion repository | |
| 10 3) You want to work with a local subversion repository | |
| 11 | |
| 12 Let's follow the steps: | |
| 13 | |
| 14 1) Setup subversion post-commit hook | |
| 15 | |
| 16 a) Rename post-commit.tmpl to post-commit | |
| 17 b) Make sure its executable (chmod +x) | |
| 18 c) Add the following to it: | |
| 19 | |
| 20 PYTHON=/usr/bin/python | |
| 21 NOTIFY=/path/to/notify-roundup.py[1] | |
| 22 CONFIG=/path/to/notify-roundup.ini[1] | |
| 23 PYTHONPATH=/path/to/roundup/instance "$PYTHON" "$NOTIFY" "$CONFIG" "$REPOS" "$REV" | |
| 24 | |
| 25 [1] notify-roundup.py and notify-roundup.ini can be found in scripts/notify-roundup | |
| 26 | |
| 27 2) Modify notify-roundup.ini | |
| 28 | |
| 29 a) Set tracker home: tracker-home = /path/to/tracker-home | |
| 30 b) Set address mappings | |
| 31 | |
| 32 3) Copy html templates from scripts/notify-roundup/html to share/roundup/templates/devel/html | |
| 33 | |
| 34 4) Copy revision_info.py extension from scripts/notify-roundup/extensions to share/roundup/templates/devel/extensions | |
| 35 | |
| 36 5) Now, now, this wasn't so hard :) | |
| 37 | |
| 38 How-to format subversion commit message | |
| 39 ======================================= | |
| 40 | |
| 41 By default, notify-roundup handles bugs. | |
| 42 To change status of bug1, format your commit | |
| 43 message like this: | |
| 44 | |
| 45 bug1 pending | |
| 46 | |
| 47 Current limitations | |
| 48 =================== | |
| 49 | |
| 50 1) Notify-roundup can work only with one item-class | |
| 51 2) Notify-roundup can only modify Status | |
| 52 | |
| 53 We are aware of the those limitations, and have plans to alleviate them in the future. |