Mercurial > p > roundup > code

annotate scripts/notify-roundup/doc/README @ 4166:fe9b0fdb1790 gsoc-2009

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