Mercurial > p > roundup > code
comparison scripts/notify-roundup/doc/README.hg @ 4197:e5917e2386d4 gsoc-2009
Fixed a lot of problems with hg notify implementation
| author | Pygi <pygi@users.sourceforge.net> |
|---|---|
| date | Wed, 08 Jul 2009 20:54:11 +0000 |
| parents | 1eaef431a785 |
| children |
comparison
equal
deleted
inserted
replaced
| 4196:1eaef431a785 | 4197:e5917e2386d4 |
|---|---|
| 12 Let's follow the steps: | 12 Let's follow the steps: |
| 13 | 13 |
| 14 1) Setup Mercurial post-commit hook | 14 1) Setup Mercurial post-commit hook |
| 15 | 15 |
| 16 a) Copy notify-roundup.sh from scripts/notify-roundup/hg/notify-roundup.sh to somewhere | 16 a) Copy notify-roundup.sh from scripts/notify-roundup/hg/notify-roundup.sh to somewhere |
| 17 b) Change paths to notify-roundup.{py,ini} and your roundup instance inside notify-roundup.sh [1] | |
| 17 b) Make sure its executable (chmod +x) | 18 b) Make sure its executable (chmod +x) |
| 18 c) Add the following to /path/to/hg/repo/.hg/hgrc | 19 c) Add the following to /path/to/hg/repo/.hg/hgrc |
| 19 | 20 |
| 20 [hooks] | 21 [hooks] |
| 21 commit = /path/to/notify-roundup.sh | 22 commit = /path/to/notify-roundup.sh |
| 23 | |
| 24 Note: Commit should probably be changed by "incoming". This is subject to further investigation. | |
| 22 | 25 |
| 23 [1] notify-roundup.py and notify-roundup.ini can be found in scripts/notify-roundup | 26 [1] notify-roundup.py and notify-roundup.ini can be found in scripts/notify-roundup |
| 24 | 27 |
| 25 2) Modify notify-roundup.ini | 28 2) Modify notify-roundup.ini |
| 26 | 29 |
| 27 a) Set tracker home: tracker-home = /path/to/tracker-home | 30 a) Set tracker home: tracker-home = /path/to/tracker-home |
| 28 b) Set address mappings | 31 b) Set address mappings |
| 32 Please be aware that we are playing tricks with Mercurial here. Your Roundup user should be the same | |
| 33 as your first name for Mercurial. Lets explore that further with an example: | |
| 34 | |
| 35 HG author is set as: Mario Danic <mario@nospam.com> | |
| 36 Notify-roundup would look for address mapping like this: | |
| 37 mario = whatever_email_you_registered_with_to_Roundup | |
| 38 | |
| 39 So it takes your first name, lowers all chars and uses mappings | |
| 40 to find appropriate Roundup user. | |
| 29 c) Set VCS type to hg | 41 c) Set VCS type to hg |
| 30 | 42 |
| 31 3) Replace "/home/mario/Projects/roundup-hg" in notify-roundup.py with path to your repository | 43 3) Now, now, this wasn't so hard :) |
| 32 | 44 |
| 33 How-to format mercurial commit message | 45 How-to format mercurial commit message |
| 34 ======================================= | 46 ======================================= |
| 35 | 47 |
| 36 By default, notify-roundup handles bugs. | 48 By default, notify-roundup handles bugs. |
| 44 | 56 |
| 45 1) Notify-roundup can work only with one item-class | 57 1) Notify-roundup can work only with one item-class |
| 46 2) Notify-roundup can only modify Status | 58 2) Notify-roundup can only modify Status |
| 47 3) Commit date isn't parsed | 59 3) Commit date isn't parsed |
| 48 4) Summary isn't composed | 60 4) Summary isn't composed |
| 49 5) HG repository path is hard-coded | 61 5) Changed files should be generated and posted |
| 50 6) Changed files should be generated and posted | 62 6) Diff should be created for vcs_rev page |
| 51 7) Diff should be created for vcs_rev page | 63 7) Parse multiple lines of commit message |
| 52 8) Parse multiple lines of commit message | 64 * This might already work |
| 53 | 65 |
| 54 We are aware of the those limitations, and have plans to alleviate them in the future. | 66 We are aware of the those limitations, and have plans to alleviate them in the future. |