1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
|
Overview
========
The interactive email interface to Bugs Everywhere (BE) attempts to
provide a Debian-bug-tracking-system-style interface to a BE
repository. Users can mail in bug reports, comments, or control
requests, which will be committed to the served repository.
Developers can then pull the changes they approve of from the served
repository into their other repositories and push updates back onto
the served repository.
For details about the Debian bug tracking system that inspired this
interface, see http://www.debian.org/Bugs .
Architecture
============
In order to reduce setup costs, the entire interface can piggyback on
an existing email address, although from a security standpoint it's
probably best to create a dedicated user. Incoming email is filtered
by procmail, with matching emails being piped into be-handle-mail for
execution.
Once be-handle-mail receives the email, the parsing method is selected
according to the subject tag that procmail used grab the email in the
first place. There are four parsing styles:
Style Subject
creating bugs [be-bug:submit] new bug summary
commenting on bugs [be-bug:<bug-id>] commit message
control [be-bug] commit message
These are analogous to submit@bugs.debian.org, nnn@bugs.debian.org,
and control@bugs.debian.org respectively.
Creating bugs
=============
This interface creates a bug whose summary is given by the email's
post-tag subject. The body of the email must begin with a
pseudo-header containing at least the "Version" field. Anything after
the pseudo-header and before a line starting with '--' is, if present,
attached as the bug's first comment.
From jdoe@example.com Fri Apr 18 12:00:00 2008
From: John Doe <jdoe@example.com>
Date: Fri, 18 Apr 2008 12:00:00 +0000
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Subject: [be-bug:submit] Need tests for the email interface.
Version: XYZ
Severity: minor
Someone should write up a series of test emails to send into
be-handle mail so we can test changes quickly without having to
use procmail.
--
Goofy tagline not included.
Available pseudo-headers are Version, Reporter, Assign, Depend,
Severity, Status, Tag, and Target.
Commenting on bugs
==================
This interface appends a comment to the bug specified in the subject
tag. The the first non-multipart body is attached with the
appropriate content-type. In the case of "text/plain" contents,
anything following a line starting with '--' is stripped.
From jdoe@example.com Fri Apr 18 12:00:00 2008
From: John Doe <jdoe@example.com>
Date: Fri, 18 Apr 2008 12:00:00 +0000
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Subject: [be-bug:XYZ] Isolated problem in baz()
Finally tracked it down to the bar() call. Some sort of
string<->unicode conversion problem. Solution ideas?
--
Goofy tagline not included.
Controlling bugs
================
This interface consists of a list of allowed be commands, with one
command per line. Blank lines and lines beginning with '#' are
ignored, as well anything following a line starting with '--'. All
the listed commands are executed in order and their output returned.
The commands are split into arguments with the POSIX-compliant
shlex.split().
From jdoe@example.com Fri Apr 18 12:00:00 2008
From: John Doe <jdoe@example.com>
Date: Fri, 18 Apr 2008 12:00:00 +0000
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Subject: [be-bug] I'll handle XYZ by release 1.2.3
assign XYZ "John Doe <jdoe@example.com>"
status XYZ assigned
severity XYZ critical
target XYZ 1.2.3
--
Goofy tagline ignored.
Example emails
==============
Take a look at my interfaces/email/interactive/examples for some
more examples.
Procmail rules
==============
The file _procmailrc as it stands is fairly appropriate for as a
dedicated user's ~/.procmailrc. It forwards matching mail to
be-handle-mail, which should be installed somewhere in the user's
path. All non-matching mail is dumped into /dev/null. Everything
procmail does will be logged to ~/be-mail/procmail.log.
If you're piggybacking the interface on top of an existing account,
you probably only need to add the be-handle-mail stanza to your
existing ~/.procmailrc, since you will still want to receive non-bug
emails.
Note that you will probably have to add a
--be-dir /path/to/served/repository
option to the be-handle-mail invocation so it knows what repository to
serve.
Multiple repositories may be served by the same email address by adding
multiple be-handle-mail stanzas, each matching a different tag, for
example the "[be-bug" portion of the stanza could be "[projectX-bug",
"[projectY-bug", etc. If you change the base tag, be sure to add a
--tag-base "projectX-bug"
or equivalent to your be-handle-mail invocation.
Testing
=======
Send test emails in to be-handle-mail with something like
cat examples/blank | ./be-handle-mail -o -l - -a
|
