Mercurial > p > roundup > code
comparison scripts/notify-roundup/doc/README.hg @ 4195:f70e9ea70900 gsoc-2009
Initial hg readme
| author | Pygi <pygi@users.sourceforge.net> |
|---|---|
| date | Tue, 07 Jul 2009 20:50:16 +0000 |
| parents | |
| children | 1eaef431a785 |
comparison
equal
deleted
inserted
replaced
| 4194:989d0d08498a | 4195:f70e9ea70900 |
|---|---|
| 1 Roundup devel tracker in love with Mercurial | |
| 2 ============================================= | |
| 3 | |
| 4 This document serves a tutorial on setting up a Roundup instance | |
| 5 with devel template featuring Mercurial 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 mercurial repository | |
| 10 3) You want to work with a local mercurial repository | |
| 11 | |
| 12 Let's follow the steps: | |
| 13 | |
| 14 1) Setup Mercurial post-commit hook | |
| 15 | |
| 16 a) Copy notify-roundup.sh from scripts/notify-roundup/hg/notify-roundup.sh to somewhere | |
| 17 b) Make sure its executable (chmod +x) | |
| 18 c) Add the following to /path/to/hg/repo/.hg/hgrc | |
| 19 | |
| 20 [hooks] | |
| 21 commit = /path/to/notify-roundup.sh | |
| 22 | |
| 23 [1] notify-roundup.py and notify-roundup.ini can be found in scripts/notify-roundup | |
| 24 | |
| 25 2) Modify notify-roundup.ini | |
| 26 | |
| 27 a) Set tracker home: tracker-home = /path/to/tracker-home | |
| 28 b) Set address mappings | |
| 29 c) Set VCS type to hg | |
| 30 | |
| 31 3) Replace "/home/mario/Projects/roundup-hg" in notify-roundup.py with path to your repository | |
| 32 | |
| 33 How-to format mercurial commit message | |
| 34 ======================================= | |
| 35 | |
| 36 By default, notify-roundup handles bugs. | |
| 37 To change status of bug1, format your commit | |
| 38 message like this: | |
| 39 | |
| 40 bug1 pending | |
| 41 | |
| 42 Current limitations and bugs | |
| 43 ============================ | |
| 44 | |
| 45 1) Notify-roundup can work only with one item-class | |
| 46 2) Notify-roundup can only modify Status | |
| 47 3) Commit date isn't parsed | |
| 48 4) Summary isn't composed | |
| 49 5) HG repository path is hard-coded | |
| 50 6) Changed files should be generated and posted | |
| 51 7) Diff should be created for vcs_rev page | |
| 52 | |
| 53 We are aware of the those limitations, and have plans to alleviate them in the future. |