release-script: Merge branch 'release/v1.11.6'

Author: aoeftiger

PyHEADTAIL/_version.py

@@ -1 +1 @@
-__version__ = '1.11.5'
+__version__ = '1.11.6'

PyHEADTAIL/feedback/transverse_damper.py

@@ -9,7 +9,6 @@
 import numpy as np
 from scipy.special import k0
 from scipy.constants import c, e
-import pylab as plt
 
 
 class TransverseDamper(object):

PyHEADTAIL/feedback/widebandfeedback.py

@@ -9,7 +9,6 @@
 import numpy as np
 from scipy.special import k0
 from scipy.constants import c, e
-import pylab as plt
 
 
 class TransferFunction(object):

release.py

@@ -5,9 +5,9 @@
 https://github.com/PyCOMPLETE/PyHEADTAIL/wiki/Our-Development-Workflow
 
 Requires git, hub (the github tool, https://hub.github.com/) and importlib
-(included in python >=2.7) installed.
+(included in python >=2.7) to be installed.
 
-Should be PEP440 conformal.
+Conforms with PEP440 (especially the versioning needs to follow this).
 
 @copyright: CERN
 @date: 26.01.2017
@@ -18,11 +18,17 @@
 import importlib # available from PyPI for Python <2.7
 import os, subprocess
 
+# python2/3 compatibility for raw_input/input:
+if hasattr(__builtins__, 'raw_input'):
+    input = raw_input
+
 # CONFIG
 version_location = 'PyHEADTAIL._version' # in python relative module notation
 # (e.g. PyHEADTAIL._version for PyHEADTAIL/_version.py)
 test_script_location = 'prepush' # in python relative module notation
 release_branch_prefix = 'release/v' # prepended name of release branch
+github_user = 'PyCOMPLETE'
+github_repo = 'PyHEADTAIL'
 
 
 parser = argparse.ArgumentParser(
@@ -125,13 +131,68 @@ def ensure_hub_is_installed():
     '''
     try:
         assert subprocess.call(["hub", "--version"]) == 0
-    except OSError:
+    except (OSError, AssertionError):
         raise OSError(
             'The github command-line tool is needed for '
             'opening the pull request for the release. '
             'Please install hub from https://hub.github.com/ !'
         )
 
+def ensure_gothub_is_installed():
+    '''Check whether gothub (to draft github releases) is installed.
+    If not, throw an error with an installation note.
+    '''
+    try:
+        assert subprocess.call(["gothub", "--version"]) == 0
+    except (OSError, AssertionError):
+        raise OSError(
+            'The gothub command-line tool is needed for '
+            'drafting releases on github. '
+            'Please install gothub from '
+            'https://github.com/itchio/gothub !'
+        )
+
+def ensure_gitpulls_is_installed():
+    '''Check whether the gem git-pulls (to get github pull requests) is
+    installed.
+    If not, throw an error with an installation note.
+    '''
+    try:
+        assert subprocess.call(["git", "pulls"]) == 0
+    except (OSError, AssertionError):
+        raise OSError(
+            'The gothub command-line tool is needed for '
+            'checking the pull request text from the release. '
+            'Please install git-pulls '
+            'from https://github.com/schacon/git-pulls !'
+        )
+
+def check_release_tools():
+    '''Return whether git-pulls and gothub are installed (needed for
+    drafting the github release from CLI). If not, ask whether user
+    wants to continue and draft the release manually (if this is not
+    the case, raise exception!).
+    '''
+    try:
+        ensure_gitpulls_is_installed()
+        ensure_gothub_is_installed()
+        return True
+    except OSError:
+        answer = ''
+        accept = ['y', 'yes', 'n', 'no']
+        while answer not in accept:
+            answer = input(
+                '!!! You do not have all required tools installed to '
+                'automatically draft a release. Do you want to continue '
+                'and manually draft the release on github afterwards?\n'
+                '[y/N] ').lower()
+            if not answer:
+                answer = 'n'
+        if answer == 'n' or answer == 'no':
+            raise
+        else:
+            return False
+
 def current_branch():
     '''Return current git branch name.'''
     # get the current branch name, strip trailing whitespaces using rstrip()
@@ -172,14 +233,42 @@ def git_status():
     )
     print (output)
 
+def get_pullrequest_message(release_version):
+    '''Fetch message from open pull request corresponding to this
+    release_version.
+    '''
+    fetched = subprocess.check_output(['git', 'pulls', 'update'])
+    pr_number = None
+    for line in fetched.split('\n'):
+        if "PyCOMPLETE:release/v{}".format(release_version) in line:
+            pr_number = line.split()[0]
+            break
+    if pr_number is None:
+        raise EnvironmentError(
+            'Could not find open pull request for this release version. '
+            'Did you properly initiate the release process '
+            '(step 1 in ./release.py --help)?')
+    text = subprocess.check_output(['git', 'pulls', 'show', pr_number])
+    output = []
+    for line in text.split('\n')[5:]:
+        if line != '------------':
+            output.append(line)
+        else:
+            break
+    output[0] = output[0][11:] # remove "Title    : "
+    return '\n'.join(output)
+
 
 # DEFINE TWO STEPS FOR RELEASE PROCESS:
 
 def init_release(part):
     '''Initialise release process.'''
-    if not current_branch() == 'develop':
+    if not current_branch() == 'develop' and not (
+            current_branch()[:7] == 'hotfix/' and
+            part == 'patch'):
         raise EnvironmentError(
-            'Releases can only be initiated from the develop branch!')
+            'Releases can only be initiated from the develop branch! '
+            '(Releasing a patch is allowed from a hotfix/ branch as well.)')
     if is_worktree_dirty():
         git_status()
         raise EnvironmentError('Release process can only be initiated on '
@@ -213,6 +302,11 @@ def finalise_release():
         raise EnvironmentError('The PyHEADTAIL tests fail. Please fix '
                                'the tests first!')
     print ('*** The PyHEADTAIL tests have successfully terminated.')
+
+    # all tools installed to automatically draft release?
+    draft_release = check_release_tools()
+
+    # bump version file
     new_version = establish_new_version(version_location)
 
     # make sure to push any possible release branch commits
@@ -240,12 +334,23 @@ def finalise_release():
     assert subprocess.call(["git", "merge", "master"]) == 0
     assert subprocess.call(["git", "push", "origin", "develop"]) == 0
 
-    # TO DO: publish github release (with text from pull request open in editor)
-
     # delete release branch
     assert subprocess.call(["git", "branch", "-d", rbranch]) == 0
     assert subprocess.call(["git", "push", "origin", ":" + rbranch]) == 0
 
+    # publish github release (with message from pull request)
+    if draft_release:
+        message = get_pullrequest_message(new_version)
+        assert subprocess.call(
+            ['gothub', 'release', '-u', github_user, '-r', github_repo,
+             '-t', 'v' + new_version,
+             '-n', '"PyHEADTAIL v{}"'.format(new_version),
+             '-d', '"{}"'.format(message),
+             '-c', 'master'])
+    else:
+        print ('*** Remember to manually draft this release from the '
+               'github website.')
+
 # ALGORITHM FOR RELEASE PROCESS:
 if __name__ == '__main__':
     print ('*** Current working directory:\n' + os.getcwd() + '\n')