release.py

   1 #!/usr/bin/python
   2 #
   3 # Copyright (C) 2009-2010 W. Trevor King <wking@drexel.edu>
   4 #
   5 # This file is part of Bugs Everywhere.
   6 #
   7 # Bugs Everywhere is free software; you can redistribute it and/or modify it
   8 # under the terms of the GNU General Public License as published by the
   9 # Free Software Foundation, either version 2 of the License, or (at your
  10 # option) any later version.
  11 #
  12 # Bugs Everywhere is distributed in the hope that it will be useful, but
  13 # WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 # General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with Bugs Everywhere.  If not, see <http://www.gnu.org/licenses/>.
  19
  20 import os
  21 import os.path
  22 import shutil
  23 import string
  24 import sys
  25
  26 from libbe.util.subproc import Pipe, invoke
  27 from update_copyright import update_authors, update_files
  28
  29
  30 INITIAL_COMMIT = '1bf1ec598b436f41ff27094eddf0b28c797e359d'
  31
  32
  33 def validate_tag(tag):
  34     """
  35     >>> validate_tag('1.0.0')
  36     >>> validate_tag('A.B.C-r7')
  37     >>> validate_tag('A.B.C r7')
  38     Traceback (most recent call last):
  39       ...
  40     Exception: Invalid character ' ' in tag 'A.B.C r7'
  41     >>> validate_tag('"')
  42     Traceback (most recent call last):
  43       ...
  44     Exception: Invalid character '"' in tag '"'
  45     >>> validate_tag("'")
  46     Traceback (most recent call last):
  47       ...
  48     Exception: Invalid character ''' in tag '''
  49     """
  50     for char in tag:
  51         if char in string.digits:
  52             continue
  53         elif char in string.letters:
  54             continue
  55         elif char in ['.','-']:
  56             continue
  57         raise Exception("Invalid character '%s' in tag '%s'" % (char, tag))
  58
  59 def pending_changes():
  60     """Use `git diff`s output to detect change.
  61     """
  62     status,stdout,stderr = invoke(['git', 'diff', 'HEAD'])
  63     if len(stdout) == 0:
  64         return False
  65     return True
  66
  67 def set_release_version(tag):
  68     print "set libbe.version._VERSION = '%s'" % tag
  69     invoke(['sed', '-i', "s/^# *_VERSION *=.*/_VERSION = '%s'/" % tag,
  70             os.path.join('libbe', 'version.py')])
  71
  72 def remove_makefile_libbe_version_dependencies(filename):
  73     print "set %s LIBBE_VERSION :=" % filename
  74     invoke(['sed', '-i', "s/^LIBBE_VERSION *:=.*/LIBBE_VERSION :=/",
  75             filename])
  76
  77 def commit(commit_message):
  78     print 'commit current status:', commit_message
  79     invoke(['git', 'commit', '-a', '-m', commit_message])
  80
  81 def tag(tag):
  82     print 'tag current revision', tag
  83     invoke(['git', 'tag', tag])
  84
  85 def export(target_dir):
  86     if not target_dir.endswith(os.path.sep):
  87         target_dir += os.path.sep
  88     print 'export current revision to', target_dir
  89     p = Pipe([['git', 'archive', '--prefix', target_dir, 'HEAD'],
  90               ['tar', '-xv']])
  91     assert p.status == 0, p.statuses
  92
  93 def make_version():
  94     print 'generate libbe/_version.py'
  95     invoke(['make', os.path.join('libbe', '_version.py')])
  96
  97 def make_changelog(filename, tag):
  98     """Generate a ChangeLog from the git history.
  99
 100     Not the most ChangeLog-esque format, but iterating through commits
 101     by hand is just too slow.
 102     """
 103     print 'generate ChangeLog file', filename, 'up to tag', tag
 104     invoke(['git', 'log', '--no-merges',
 105             '%s..%s' % (INITIAL_COMMIT, tag)],
 106            stdout=open(filename, 'w')),
 107
 108 def set_vcs_name(be_dir, vcs_name='None'):
 109     """Exported directory is not a git repository, so set vcs_name to
 110     something that will work.
 111       vcs_name: new_vcs_name
 112     """
 113     for directory in os.listdir(be_dir):
 114         if not os.path.isdir(os.path.join(be_dir, directory)):
 115             continue
 116         filename = os.path.join(be_dir, directory, 'settings')
 117         if os.path.exists(filename):
 118             print 'set vcs_name in', filename, 'to', vcs_name
 119             invoke(['sed', '-i', "s/^vcs_name:.*/vcs_name: %s/" % vcs_name,
 120                     filename])
 121
 122 def create_tarball(tag):
 123     release_name='be-%s' % tag
 124     export_dir = release_name
 125     export(export_dir)
 126     make_version()
 127     remove_makefile_libbe_version_dependencies(
 128         os.path.join(export_dir, 'Makefile'))
 129     print 'copy libbe/_version.py to %s/libbe/_version.py' % export_dir
 130     shutil.copy(os.path.join('libbe', '_version.py'),
 131                 os.path.join(export_dir, 'libbe', '_version.py'))
 132     make_changelog(os.path.join(export_dir, 'ChangeLog'), tag)
 133     set_vcs_name(os.path.join(export_dir, '.be'))
 134     tarball_file = '%s.tar.gz' % release_name
 135     print 'create tarball', tarball_file
 136     invoke(['tar', '-czf', tarball_file, export_dir])
 137     print 'remove', export_dir
 138     shutil.rmtree(export_dir)
 139
 140 def test():
 141     import doctest
 142     doctest.testmod()
 143
 144 if __name__ == '__main__':
 145     import optparse
 146     usage = """%prog [options] TAG
 147
 148 Create a git tag and a release tarball from the current revision.
 149 For example
 150   %prog 1.0.0
 151
 152 You may wish to test this out in a dummy branch first to make sure it
 153 works as expected to avoid the tedium of unwinding the version-bump
 154 commit if it fails.
 155 """
 156     p = optparse.OptionParser(usage)
 157     p.add_option('--test', dest='test', default=False,
 158                  action='store_true', help='Run internal tests and exit')
 159     options,args = p.parse_args()
 160
 161     if options.test == True:
 162         test()
 163         sys.exit(0)
 164
 165     assert len(args) == 1, '%d (!= 1) arguments: %s' % (len(args), args)
 166     _tag = args[0]
 167     validate_tag(_tag)
 168
 169     if pending_changes() == True:
 170         print "Handle pending changes before releasing."
 171         sys.exit(1)
 172     set_release_version(_tag)
 173     print "Update copyright information..."
 174     update_authors()
 175     update_files()
 176     commit("Bumped to version %s" % _tag)
 177     tag(_tag)
 178     create_tarball(_tag)