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