lbry-desktop/build/release.py

294 lines
9.7 KiB
Python
Raw Normal View History

2017-02-21 04:58:29 +01:00
"""Trigger a release.
This script is to be run locally (not on a build server).
"""
import argparse
import contextlib
import logging
import os
import re
2017-03-14 04:12:40 +01:00
import string
2017-02-21 04:58:29 +01:00
import subprocess
import sys
import git
import github
2017-02-22 05:29:23 +01:00
import changelog
2017-02-21 04:58:29 +01:00
# TODO: ask bumpversion for these
LBRY_PARTS = ('major', 'minor', 'patch', 'release', 'candidate')
LBRYUM_PARTS = ('major', 'minor', 'patch')
2017-02-21 04:58:29 +01:00
def main():
parser = argparse.ArgumentParser()
parser.add_argument(
"lbry_part", help="part of lbry version to bump",
choices=LBRY_PARTS
)
2017-03-14 04:12:40 +01:00
parser.add_argument(
"--skip-lbryum", help="skip bumping lbryum, even if there are changes",
action="store_true",
)
parser.add_argument(
2017-03-06 17:10:36 +01:00
"--lbryum-part", help="part of lbryum version to bump",
choices=LBRYUM_PARTS
)
parser.add_argument(
"--last-release",
help=("manually set the last release version. The default is to query and parse the"
2017-03-14 03:16:39 +01:00
" value from the release page.")
)
2017-03-14 04:12:40 +01:00
parser.add_argument(
"--skip-sanity-checks", action="store_true")
parser.add_argument(
"--require-changelog", action="store_true",
help=("Set this flag to raise an exception if a submodules has changes without a"
" corresponding changelog entry. The default is to log a warning")
)
2017-03-14 04:12:40 +01:00
parser.add_argument(
"--skip-push", action="store_true",
help="Set to not push changes to remote repo"
)
2017-02-21 04:58:29 +01:00
args = parser.parse_args()
base = git.Repo(os.getcwd())
2017-03-14 04:12:40 +01:00
branch = 'master'
2017-02-21 04:58:29 +01:00
if not args.skip_sanity_checks:
2017-02-22 18:44:05 +01:00
run_sanity_checks(base, branch)
2017-02-21 04:58:29 +01:00
2017-03-06 17:10:36 +01:00
base_repo = Repo('lbry-app', args.lbry_part, os.getcwd())
base_repo.assert_new_tag_is_absent()
2017-03-14 04:12:40 +01:00
last_release = args.last_release or base_repo.get_last_tag()
logging.info('Last release: %s', last_release)
2017-02-21 04:58:29 +01:00
gh_token = get_gh_token()
2017-02-21 04:58:29 +01:00
auth = github.Github(gh_token)
github_repo = auth.get_repo('lbryio/lbry-app')
2017-03-14 04:12:40 +01:00
names = ['lbryum', 'lbry']
repos = {name: Repo(name, get_part(args, name)) for name in names}
2017-02-21 04:58:29 +01:00
changelogs = {}
for repo in repos.values():
2017-02-22 16:39:54 +01:00
logging.info('Processing repo: %s', repo.name)
2017-03-14 04:12:40 +01:00
repo.checkout(branch)
last_submodule_hash = base_repo.get_submodule_hash(last_release, repo.name)
if repo.has_changes_from_revision(last_submodule_hash):
if repo.name == 'lbryum':
if args.skip_lbryum:
continue
if not repo.part:
repo.part = get_lbryum_part()
2017-02-22 16:39:54 +01:00
entry = repo.get_changelog_entry()
2017-02-22 20:06:38 +01:00
if entry:
changelogs[repo.name] = entry.strip()
repo.add_changelog()
else:
msg = 'Changelog entry is missing for {}'.format(repo.name)
if args.require_changelog:
raise Exception(msg)
else:
logging.warning(msg)
else:
2017-02-22 16:39:54 +01:00
logging.warning('Submodule %s has no changes.', repo.name)
if repo.name == 'lbryum':
# The other repos have their version track each other so need to bump
# them even if there aren't any changes, but lbryum should only be
# bumped if it has changes
continue
2017-03-09 16:33:18 +01:00
# bumpversion will fail if there is already the tag we want in the repo
repo.assert_new_tag_is_absent()
2017-02-22 16:39:54 +01:00
repo.bumpversion()
2017-02-21 04:58:29 +01:00
release_msg = get_release_msg(changelogs, names)
for name in names:
base.git.add(name)
2017-03-06 17:10:36 +01:00
base_repo.bumpversion()
2017-02-21 04:58:29 +01:00
current_tag = base.git.describe()
is_rc = re.match('\drc\d+$', current_tag) is not None
github_repo.create_git_release(current_tag, current_tag, release_msg, draft=True,
prerelease=is_rc)
2017-03-14 03:16:39 +01:00
no_change_msg = ('No change since the last release. This release is simply a placeholder'
' so that LBRY and LBRY App track the same version')
lbrynet_daemon_release_msg = changelogs.get('lbry', no_change_msg)
auth.get_repo('lbryio/lbry').create_git_release(
current_tag, current_tag, lbrynet_daemon_release_msg, draft=True)
if not args.skip_push:
2017-03-06 23:47:10 +01:00
for repo in repos.values():
repo.git.push(follow_tags=True)
base.git.push(follow_tags=True, recurse_submodules='check')
else:
logging.info('Skipping push; you will have to reset and delete tags if '
2017-03-06 17:10:36 +01:00
'you want to run this script again. Take a look at reset.sh; '
'it probably does what you want.')
2017-02-21 04:58:29 +01:00
def get_gh_token():
if 'GH_TOKEN' in os.environ:
2017-03-14 04:12:40 +01:00
return os.environ['GH_TOKEN']
else:
2017-03-14 03:16:39 +01:00
print """
Please enter your personal access token. If you don't have one
See https://github.com/lbryio/lbry-app/wiki/Release-Script#generate-a-personal-access-token
for instructions on how to generate one.
You can also set the GH_TOKEN environment variable to avoid seeing this message
in the future"""
2017-03-14 04:12:40 +01:00
return raw_input('token: ').strip()
2017-03-14 04:12:40 +01:00
def get_lbryum_part():
2017-03-14 03:16:39 +01:00
print """The lbryum repo has changes but you didn't specify how to bump the
2017-03-14 04:12:40 +01:00
version. Please enter one of: {}""".format(', '.join(LBRYUM_PARTS))
while True:
2017-03-14 04:12:40 +01:00
part = raw_input('part: ').strip()
if part in LBRYUM_PARTS:
2017-03-14 04:12:40 +01:00
return part
print 'Invalid part. Enter one of: {}'.format(', '.join(LBRYUM_PARTS))
2017-02-22 18:44:05 +01:00
2017-02-22 20:06:38 +01:00
2017-02-21 04:58:29 +01:00
def get_release_msg(changelogs, names):
lines = []
for name in names:
entry = changelogs.get(name)
if not entry:
continue
lines.append('## {}\n'.format(name))
lines.append('{}\n'.format(entry))
return '\n'.join(lines)
2017-02-22 18:44:05 +01:00
def run_sanity_checks(base, branch):
2017-02-21 04:58:29 +01:00
if base.is_dirty():
print 'Cowardly refusing to release a dirty repo'
sys.exit(1)
if base.active_branch.name != branch:
print 'Cowardly refusing to release when not on the {} branch'.format(branch)
sys.exit(1)
2017-02-22 16:39:54 +01:00
if is_behind(base, branch):
print 'Cowardly refusing to release when behind origin'
2017-02-21 04:58:29 +01:00
sys.exit(1)
check_bumpversion()
2017-02-22 16:39:54 +01:00
def is_behind(base, branch):
base.remotes.origin.fetch()
rev_list = '{branch}...origin/{branch}'.format(branch=branch)
commits_behind = base.git.rev_list(rev_list, right_only=True, count=True)
commits_behind = int(commits_behind)
return commits_behind > 0
2017-02-21 04:58:29 +01:00
def check_bumpversion():
def require_new_version():
2017-02-21 04:58:29 +01:00
print 'Install bumpversion: pip install -U git+https://github.com/lbryio/bumpversion.git'
sys.exit(1)
try:
output = subprocess.check_output(['bumpversion', '-v'], stderr=subprocess.STDOUT)
output = output.strip()
if output != 'bumpversion 0.5.4-lbry':
require_new_version()
2017-02-21 20:33:11 +01:00
except (subprocess.CalledProcessError, OSError) as err:
require_new_version()
2017-02-21 04:58:29 +01:00
2017-02-22 16:39:54 +01:00
2017-02-21 04:58:29 +01:00
def get_part(args, name):
2017-03-09 18:31:07 +01:00
return getattr(args, name + '_part') or args.lbry_part
2017-02-21 04:58:29 +01:00
class Repo(object):
2017-03-06 17:10:36 +01:00
def __init__(self, name, part, directory=None):
2017-02-21 04:58:29 +01:00
self.name = name
2017-02-22 05:29:23 +01:00
self.part = part
2017-03-06 17:10:36 +01:00
self.directory = directory or os.path.join(os.getcwd(), name)
2017-02-21 04:58:29 +01:00
self.git_repo = git.Repo(self.directory)
self.saved_commit = None
2017-02-22 05:29:23 +01:00
self._bumped = False
2017-02-21 04:58:29 +01:00
2017-03-14 04:12:40 +01:00
def get_last_tag(self):
return string.split(self.git_repo.git.describe(tags=True), '-')[0]
def get_submodule_hash(self, revision, submodule_path):
line = getattr(self.git_repo.git, 'ls-tree')(revision, submodule_path)
return string.split(line)[2] if line else None
def has_changes_from_revision(self, revision):
2017-03-15 16:18:59 +01:00
commit = str(self.git_repo.commit())
logging.info('%s =? %s', commit, revision)
return commit != revision
2017-02-21 04:58:29 +01:00
def save_commit(self):
self.saved_commit = self.git_repo.commit()
2017-03-14 04:12:40 +01:00
logging.info('Saved ', self.git_repo.commit(), self.saved_commit)
2017-02-21 04:58:29 +01:00
2017-03-14 04:12:40 +01:00
def checkout(self, branch):
2017-02-21 04:58:29 +01:00
self.git_repo.git.checkout(branch)
2017-02-22 18:44:05 +01:00
self.git_repo.git.pull(rebase=True)
2017-02-21 04:58:29 +01:00
def get_changelog_entry(self):
filename = os.path.join(self.directory, 'CHANGELOG.md')
2017-02-22 05:29:23 +01:00
return changelog.bump(filename, self.new_version())
2017-02-22 20:06:38 +01:00
def add_changelog(self):
with pushd(self.directory):
self.git_repo.git.add('CHANGELOG.md')
2017-02-22 05:29:23 +01:00
def new_version(self):
if self._bumped:
raise Exception('Cannot calculate a new version on an already bumped repo')
2017-02-22 16:39:54 +01:00
if not self.part:
raise Exception('Cannot calculate a new version without a part')
2017-02-22 05:29:23 +01:00
with pushd(self.directory):
output = subprocess.check_output(
['bumpversion', '--dry-run', '--list', '--allow-dirty', self.part])
2017-02-22 16:39:54 +01:00
return re.search('^new_version=(.*)$', output, re.M).group(1)
2017-02-21 04:58:29 +01:00
2017-02-22 05:29:23 +01:00
def bumpversion(self):
if self._bumped:
raise Exception('Cowardly refusing to bump a repo twice')
2017-02-22 16:39:54 +01:00
if not self.part:
raise Exception('Cannot bump version for {}: no part specified'.format(repo.name))
2017-02-21 04:58:29 +01:00
with pushd(self.directory):
2017-02-22 05:29:23 +01:00
subprocess.check_call(['bumpversion', '--allow-dirty', self.part])
self._bumped = True
2017-02-21 04:58:29 +01:00
2017-03-06 17:10:36 +01:00
def assert_new_tag_is_absent(self):
new_tag = 'v' + self.new_version()
tags = self.git_repo.git.tag()
if new_tag in tags.split('\n'):
raise Exception('Tag {} is already present in repo {}.'.format(new_tag, self.name))
2017-02-21 04:58:29 +01:00
@property
def git(self):
return self.git_repo.git
@contextlib.contextmanager
def pushd(new_dir):
previous_dir = os.getcwd()
os.chdir(new_dir)
yield
os.chdir(previous_dir)
if __name__ == '__main__':
2017-02-22 16:39:54 +01:00
logging.basicConfig(
format="%(asctime)s %(levelname)-8s %(name)s:%(lineno)d: %(message)s",
level='INFO'
)
2017-02-21 04:58:29 +01:00
sys.exit(main())
else:
log = logging.getLogger('__name__')