summaryrefslogtreecommitdiff
path: root/git-dch
blob: 9935f0f9071ebde8799a98fcac3e65f14d257055 (plain)
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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
#!/usr/bin/python
# vim: set fileencoding=utf-8 :
#
# (C) 2007 Guido Guenther <agx@sigxcpu.org>
#    This program is free software; you can redistribute it and/or modify
#    it under the terms of the GNU General Public License as published by
#    the Free Software Foundation; either version 2 of the License, or
#    (at your option) any later version.
#
#    This program is distributed in the hope that it will be useful,
#    but WITHOUT ANY WARRANTY; without even the implied warranty of
#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#    GNU General Public License for more details.
#
#    You should have received a copy of the GNU General Public License
#    along with this program; if not, write to the Free Software
#    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
#
"""Generate Debian changelog entries from git changelogs"""

import sys
import re
import os.path
import shutil
import subprocess
import gbp.command_wrappers as gbpc
from gbp.git_utils import (GitRepositoryError, GitRepository, build_tag)
from gbp.config import GbpOptionParser
from gbp.errors import GbpError
from gbp.deb_utils import parse_changelog
from gbp.command_wrappers import (Command, CommandExecFailed)

snapshot_re = "\s*\*\* SNAPSHOT build @(?P<commit>[a-z0-9]+)\s+\*\*"

def system(cmd):
    try:
        Command(cmd, shell=True)()
    except CommandExecFailed:
        raise GbpError


def add_changelog_entry(msg, author):
    "add aa single changelog entry"
    cmd = """DEBFULLNAME="%s" dch --append -- "%s" """ % (author, msg.replace('"','\\\"'))
    system(cmd)


def add_changelog_section(msg, distribution):
    "add a new changelog section"
    cmd = "dch --distribution=%s -i %s" % (distribution, msg)
    system(cmd)

def fixup_trailer():
    """fixup the changelog trailer's comitter and email address - it might
    otherwise point to the last git committer instead of the person creating
    the changelog"""
    cmd = "dch \"\""
    system(cmd)

def head_commit():
    """get the full sha1 of the last commit on HEAD"""
    commit = subprocess.Popen([ 'git-log', 'HEAD^..' ], stdout=subprocess.PIPE).stdout
    sha = commit.readline().split()[-1]
    return sha


def snapshot_version(version):
    """
    get the current release and snapshot version
    Format is <debian-version>~<release>.gbp<short-commit-id>
    """
    try:
        (release, suffix) = version.rsplit('~', 1)
        (snapshot, commit)  = suffix.split('.', 1)
        if not commit.startswith('gbp'):
            raise ValueError
        else:
            snapshot = int(snapshot)
    except ValueError: # not a snapshot release
        release = version
        snapshot = 0
    return release, snapshot


def mangle_changelog(changelog, cp, snapshot, sha='unknown'):
    """Mangle changelog to either add or remove snapshot markers"""
    try:
        tmp = '%s.%s' % (changelog, str(snapshot))
        cw = file(tmp, 'w')
        cr = file(changelog, 'r')
        cr.readline() # skip version and empty line
        cr.readline()
        print >>cw, "%(Source)s (%(MangledVersion)s) %(Distribution)s; urgency=%(urgency)s\n" % cp

        line = cr.readline()
        if re.match(snapshot_re, line):
            cr.readline() # consume the empty line
            line = ''

        if snapshot:
            print >>cw, "  ** SNAPSHOT build @%s **\n" % sha

        if line:
            print >>cw, line.rstrip()
        shutil.copyfileobj(cr, cw)
        cw.close()
        cr.close()
        os.unlink(changelog)
        os.rename(tmp, changelog)
    except OSError, e:
        raise GbpError, "Error mangling changelog %s" % e


def do_release(changelog, cp):
    "remove the snapshot header and set the distribution"
    (release, snapshot) = snapshot_version(cp['Version'])
    if snapshot:
        cp['MangledVersion'] = release
        mangle_changelog(changelog, cp, 0)
    cmd = "dch --release"
    system(cmd)


def do_snapshot(changelog, next_snapshot):
    """
    Add new snapshot banner to most recent changelog section. The next snapshot
    number is calculated by eval()'ing next_snapshot
    """
    commit = head_commit()

    cp = parse_changelog(changelog)
    (release, snapshot) = snapshot_version(cp['Version'])
    snapshot = int(eval(next_snapshot))

    suffix = "%d.gbp%s" % (snapshot, "".join(commit[0:6]))
    cp['MangledVersion'] = "%s~%s" % (release, suffix)

    mangle_changelog(changelog, cp, snapshot, commit)
    return snapshot, commit


def parse_commit(repo, commit,meta, short):
    """parse a commit and return message and author"""
    author_re = re.compile('Author: (?P<author>.*) <(?P<email>.*)>')
    msg = ''
    thanks = ''
    closes = ''
    bugs = []

    commit = repo.show(commit)
    m = author_re.match(commit[1])
    if not m:
        raise GbpError, "can't parse author of commit %s" % commit
    else:
        author = m.group('author')
    for line in commit[4:]:
        if line.startswith('    '): # commit body
            line = line[4:]
            if line.startswith('Closes: '):
                bugs += [ line.split(' ', 1)[1].strip() ]
            elif line.startswith('Thanks: '):
                thanks = line.split(' ', 1)[1].strip()
            else: # normal commit message
                if short and msg:
                    continue
                elif line.strip(): # don't add all whitespace lines
                    msg += line
        else:
            break
    if meta:
        if bugs:
            closes = ' (Closes: %s)' % ', '.join(bugs)
        if thanks:
            thanks = ' - thanks to %s' % thanks
        msg += closes + thanks
    return msg, author


def shortlog_to_dch(repo, commits, meta, short):
    """convert the changes in git shortlog format to debian changelog format"""
    commit_re = re.compile('\s+(?P<msg>.*)')
    author_re = re.compile('(?P<author>.*) \([0-9]+\)')
    author = 'Unknown'

    for commit in commits:
        msg, author = parse_commit(repo, commit, meta, short)
        add_changelog_entry(msg, author)


def guess_snapshot_commit(cp):
    """guess the last commit documented in the changelog from the snapshot banner"""
    sr = re.search(snapshot_re, cp['Changes'])
    if sr:
        return sr.group('commit')


def main(argv):
    ret = 0
    changelog = 'debian/changelog'
    until = 'HEAD'
    found_snapshot_header = False

    parser = GbpOptionParser(command=os.path.basename(argv[0]), prefix='',
                             usage='%prog [options] paths')

    parser.add_config_file_option(option_name="debian-branch", dest='debian_branch',
                      help="branch the debian patch is being developed on, default is '%(debian-branch)s'")
    parser.add_config_file_option(option_name="debian-tag", dest="debian_tag",
                      help="Format string for debian tags, default is '%(debian-tag)s'")
    parser.add_config_file_option(option_name="snapshot-number", dest="snapshot_number",
                      help="Expression to determine the next snapshot number, default is '%(snapshot-number)s'")
    parser.add_config_file_option(option_name="git-log", dest="git_log",
                      help="options to pass to git-log, default is '%(git-log)s'")
    parser.add_option("-v", "--verbose", action="store_true", dest="verbose", default=False,
                      help="verbose command execution")
    parser.add_option("-s", "--since", dest="since", help="commit to start from")
    parser.add_option("-R", "--release", action="store_true", dest="release", default=False,
                      help="mark as release")
    parser.add_option("-S", "--snapshot", action="store_true", dest="snapshot", default=False,
                      help="mark as snapshot build")
    parser.add_option("-a", "--auto", action="store_true", dest="auto", default=False,
                      help="autocomplete changelog from last snapshot or tag")
    parser.add_option("--meta", action="store_true", dest="meta", default=False,
                      help="parse meta tags in commit messages")
    parser.add_option("--full", action="store_false", dest="short", default=True,
                      help="include the full commit message")
    (options, args) = parser.parse_args(argv[1:])

    if options.snapshot and options.release:
        parser.error("--snapshot and --release are incompatible options")

    try:
        if options.verbose:
            gbpc.Command.verbose = True

        try:
            repo = GitRepository('.')
        except GitRepositoryError:
            raise GbpError, "%s is not a git repository" % (os.path.abspath('.'))

        branch = repo.get_branch()
        if options.debian_branch != branch:
            print >>sys.stderr, "You are not on branch '%s' but on '%s'" % (options.debian_branch, branch)
            raise GbpError, "Use --debian-branch to set the branch to pick changes from"

        cp = parse_changelog(changelog)

        if options.since:
            since = options.since
        else:
            since = ''
            if options.auto:
                since = guess_snapshot_commit(cp)
                if since:
                    print "Continuing from commit '%s'" % since
                    found_snapshot_header = True
                else:
                    print "Couldn't get snapshot header, using version info"
            if not since:
                since = build_tag(options.debian_tag, cp['Version'])

        if args:
            print "Only looking for changes on '%s'" % " ".join(args)
        commits = repo.commits(since, until, " ".join(args), options.git_log)
        if commits:
            if cp['Distribution'] != "UNRELEASED" and not found_snapshot_header:
                add_changelog_section(distribution="UNRELEASED", msg="UNRELEASED")
            shortlog_to_dch(repo, commits, meta=options.meta, short=options.short)
            fixup_trailer()
            if options.snapshot:
                (snap, version) = do_snapshot(changelog, options.snapshot_number)
                print "Changelog has been prepared for snapshot #%d at %s" % (snap, version)
        else:
            print "No changes detected from %s to %s." % (since, until)
        if options.release:
            do_release(changelog, cp)

    except GbpError, err:
        if len(err.__str__()):
            print >>sys.stderr, err
        ret = 1
    return ret

if __name__ == "__main__":
    sys.exit(main(sys.argv))

# vim:et:ts=4:sw=4:et:sts=4:ai:set list listchars=tab\:»·,trail\:·: