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
|
# Licensed under a 3-clause BSD style license - see LICENSE.rst
"""
This module contains hooks for zest.releaser for use in semi-automated releases
of Astropy.
"""
from __future__ import (absolute_import, division, print_function,
unicode_literals)
import io
import os
import re
import sys
import warnings
from . import AstropyDeprecationWarning
ZEST_DEPRECATION = AstropyDeprecationWarning('The zest.releaser machinery in '
'astropy is deprecated and may be removed in a future version.')
def prereleaser_middle(data):
"""
prereleaser.middle hook to replace the version string in setup.py;
zest.releaser already does this normally but it's a little inflexible about
the format.
"""
warnings.warn(ZEST_DEPRECATION)
_update_setup_py_version(data['new_version'])
def releaser_middle(data):
"""
releaser.middle hook to monkey-patch zest.releaser to support signed
tagging--currently this is the only way to do this. Also monkey-patches to
disable an annoyance where zest.releaser only creates .zip source
distributions. This is supposedly a workaround for a bug in Python 2.4,
but we don't care about Python 2.4.
"""
warnings.warn(ZEST_DEPRECATION)
from zest.releaser.git import Git
from zest.releaser.release import Releaser
# Copied verbatim from zest.releaser, but with the cmd string modified to
# use the -s option to create a signed tag and add the 'v' in front of the
# version number
def _my_create_tag(self, version):
version = 'v' + version
msg = "Tagging {}".format(version,)
cmd = 'git tag -s {} -m "{}"'.format(version, msg)
if os.path.isdir('.git/svn'):
print("\nEXPERIMENTAL support for git-svn tagging!\n")
cur_branch = open('.git/HEAD').read().strip().split('/')[-1]
print("You are on branch {}.".format(cur_branch,))
if cur_branch != 'master':
print("Only the master branch is supported for git-svn tagging.")
print("Please tag yourself.")
print("'git tag' needs to list tag named {}.".format(version,))
sys.exit()
cmd = [cmd]
local_head = open('.git/refs/heads/master').read()
trunk = open('.git/refs/remotes/trunk').read()
if local_head != trunk:
print("Your local master diverges from trunk.\n")
# dcommit before local tagging
cmd.insert(0, 'git svn dcommit')
# create tag in svn
cmd.append('git svn tag -m "{}" {}'.format(msg, version))
return cmd
# Similarly copied from zest.releaser to support use of 'v' in front
# of the version number
def _my_make_tag(self):
from zest.releaser import utils
if self.data['tag_already_exists']:
return
cmds = self.vcs.cmd_create_tag(self.data['version'])
if not isinstance(cmds, list):
cmds = [cmds]
if len(cmds) == 1:
print("Tag needed to proceed, you can use the following command:")
for cmd in cmds:
print(cmd)
if utils.ask("Run this command"):
print(os.system(cmd))
else:
# all commands are needed in order to proceed normally
print("Please create a tag for {} yourself and rerun.".format(
self.data['version'],))
sys.exit()
if not self.vcs.tag_exists('v' + self.data['version']):
print("\nFailed to create tag {}!".format(self.data['version'],))
sys.exit()
# Normally all this does is to return '--formats=zip', which is currently
# hard-coded as an option to always add to the sdist command; they ought to
# make this actually optional
def _my_sdist_options(self):
return ''
Git.cmd_create_tag = _my_create_tag
Releaser._make_tag = _my_make_tag
Releaser._sdist_options = _my_sdist_options
_NEW_CHANGELOG_TEMPLATE = str("""\
New Features
^^^^^^^^^^^^
- ``astropy.config``
- ``astropy.constants``
- ``astropy.convolution``
- ``astropy.coordinates``
- ``astropy.cosmology``
- ``astropy.io.ascii``
- ``astropy.io.fits``
- ``astropy.io.misc``
- ``astropy.io.registry``
- ``astropy.io.votable``
- ``astropy.modeling``
- ``astropy.nddata``
- ``astropy.stats``
- ``astropy.sphinx``
- ``astropy.table``
- ``astropy.time``
- ``astropy.units``
- ``astropy.utils``
- ``astropy.vo``
- ``astropy.wcs``
API Changes
^^^^^^^^^^^
- ``astropy.config``
- ``astropy.constants``
- ``astropy.convolution``
- ``astropy.coordinates``
- ``astropy.cosmology``
- ``astropy.io.ascii``
- ``astropy.io.fits``
- ``astropy.io.misc``
- ``astropy.io.registry``
- ``astropy.io.votable``
- ``astropy.modeling``
- ``astropy.nddata``
- ``astropy.stats``
- ``astropy.table``
- ``astropy.time``
- ``astropy.units``
- ``astropy.utils``
- ``astropy.vo``
- ``astropy.wcs``
Bug Fixes
^^^^^^^^^
- ``astropy.config``
- ``astropy.constants``
- ``astropy.convolution``
- ``astropy.coordinates``
- ``astropy.cosmology``
- ``astropy.io.ascii``
- ``astropy.io.fits``
- ``astropy.io.misc``
- ``astropy.io.registry``
- ``astropy.io.votable``
- ``astropy.modeling``
- ``astropy.nddata``
- ``astropy.stats``
- ``astropy.table``
- ``astropy.time``
- ``astropy.units``
- ``astropy.utils``
- ``astropy.vo``
- ``astropy.wcs``
Other Changes and Additions
^^^^^^^^^^^^^^^^^^^^^^^^^^^
- Nothing changed yet.
""".rstrip())
def postreleaser_before(data):
"""
postreleaser.before hook to set a different dev_version_template from the
default: By default zest.releaser uses <version>.dev0. We want just
<version>.dev without the mysterious 0.
"""
warnings.warn(ZEST_DEPRECATION)
data['dev_version_template'] = '%(new_version)s.dev'
data['nothing_changed_yet'] = _NEW_CHANGELOG_TEMPLATE
def postreleaser_middle(data):
"""
postreleaser.middle hook to update the setup.py with the new version. See
prereleaser_middle for more details.
"""
warnings.warn(ZEST_DEPRECATION)
_update_setup_py_version(data['dev_version'])
def _update_setup_py_version(version):
pattern = re.compile(r'^VERSION\s*=\s*[\'"]{1,3}')
output = io.StringIO()
with open('setup.py') as setup_py:
for line in setup_py:
if not pattern.match(line):
output.write(line.decode('utf-8'))
else:
output.write("VERSION = '{0}'\n".format(version))
with io.open('setup.py', 'w') as setup_py:
setup_py.write(output.getvalue())
|