mirror of
https://github.com/frappe/bench.git
synced 2024-09-27 22:39:03 +00:00
chore: Drop release project
Release is yet another dead / unmaintained project in bench. It used to
be in action - the tool to release ERPNext & Frappe for years but we've
moved to other automated pipelines (that have been around for a while
too). Time to say good-bye to these commands too 👋
This commit is contained in:
Gavin D'souza
parent
0f64446c17
commit
4fcda9ae22
@ -74,8 +74,6 @@ from bench.commands.utils import (
|
||||
find_benches,
|
||||
generate_command_cache,
|
||||
migrate_env,
|
||||
prepare_beta_release,
|
||||
release,
|
||||
renew_lets_encrypt,
|
||||
restart,
|
||||
set_mariadb_host,
|
||||
@ -102,11 +100,9 @@ bench_command.add_command(set_redis_socketio_host)
|
||||
bench_command.add_command(download_translations)
|
||||
bench_command.add_command(backup_site)
|
||||
bench_command.add_command(backup_all_sites)
|
||||
bench_command.add_command(release)
|
||||
bench_command.add_command(renew_lets_encrypt)
|
||||
bench_command.add_command(disable_production)
|
||||
bench_command.add_command(bench_src)
|
||||
bench_command.add_command(prepare_beta_release)
|
||||
bench_command.add_command(find_benches)
|
||||
bench_command.add_command(migrate_env)
|
||||
bench_command.add_command(generate_command_cache)
|
||||
|
||||
@ -128,29 +128,6 @@ def backup_all_sites():
|
||||
backup_all_sites(bench_path='.')
|
||||
|
||||
|
||||
@click.command('release', help="Release a Frappe app (internal to the Frappe team)")
|
||||
@click.argument('app')
|
||||
@click.argument('bump-type', type=click.Choice(['major', 'minor', 'patch', 'stable', 'prerelease']))
|
||||
@click.option('--from-branch', default='develop')
|
||||
@click.option('--to-branch', default='master')
|
||||
@click.option('--remote', default='upstream')
|
||||
@click.option('--owner', default='frappe')
|
||||
@click.option('--repo-name')
|
||||
@click.option('--dont-frontport', is_flag=True, default=False, help='Front port fixes to new branches, example merging hotfix(v10) into staging-fixes(v11)')
|
||||
def release(app, bump_type, from_branch, to_branch, owner, repo_name, remote, dont_frontport):
|
||||
from bench.release import release
|
||||
frontport = not dont_frontport
|
||||
release(bench_path='.', app=app, bump_type=bump_type, from_branch=from_branch, to_branch=to_branch, remote=remote, owner=owner, repo_name=repo_name, frontport=frontport)
|
||||
|
||||
|
||||
@click.command('prepare-beta-release', help="Prepare major beta release from develop branch")
|
||||
@click.argument('app')
|
||||
@click.option('--owner', default='frappe')
|
||||
def prepare_beta_release(app, owner):
|
||||
from bench.prepare_beta_release import prepare_beta_release
|
||||
prepare_beta_release(bench_path='.', app=app, owner=owner)
|
||||
|
||||
|
||||
@click.command('disable-production', help="Disables production environment for the bench.")
|
||||
def disable_production():
|
||||
from bench.config.production_setup import disable_production
|
||||
|
||||
@ -1,118 +0,0 @@
|
||||
#! env python
|
||||
import os
|
||||
import git
|
||||
import click
|
||||
from .config.common_site_config import get_config
|
||||
import semantic_version
|
||||
|
||||
github_username = None
|
||||
github_password = None
|
||||
|
||||
def prepare_beta_release(bench_path, app, owner='frappe', remote='upstream'):
|
||||
from .release import get_release_message
|
||||
|
||||
beta_hotfix = ''
|
||||
beta_master = click.prompt('Branch name for beta release', type=str)
|
||||
|
||||
if click.confirm("Do you want to setup hotfix for beta ?"):
|
||||
beta_hotfix = click.prompt(f'Branch name for beta hotfix ({beta_master}_hotifx)', type=str)
|
||||
|
||||
validate(bench_path)
|
||||
repo_path = os.path.join(bench_path, 'apps', app)
|
||||
version = get_bummped_version(repo_path)
|
||||
|
||||
update_branch(repo_path, remote)
|
||||
prepare_beta_master(repo_path, beta_master, version, remote)
|
||||
|
||||
if beta_hotfix:
|
||||
prepare_beta_hotfix(repo_path, beta_hotfix, remote)
|
||||
|
||||
tag_name = merge_beta_release_to_develop(repo_path, beta_master, remote, version)
|
||||
push_branches(repo_path, beta_master, beta_hotfix, remote)
|
||||
create_github_release(repo_path, tag_name, '', owner, remote)
|
||||
|
||||
def validate(bench_path):
|
||||
from .release import validate
|
||||
|
||||
config = get_config(bench_path)
|
||||
validate(bench_path, config)
|
||||
|
||||
def get_bummped_version(repo_path):
|
||||
from .release import get_current_version
|
||||
current_version = get_current_version(repo_path, 'master')
|
||||
|
||||
v = semantic_version.Version(current_version)
|
||||
|
||||
if v.major:
|
||||
v.major += 1
|
||||
v.minor = 0
|
||||
v.patch = 0
|
||||
v.prerelease = ['staging']
|
||||
|
||||
return str(v)
|
||||
|
||||
def update_branch(repo_path, remote):
|
||||
from .release import update_branch
|
||||
update_branch(repo_path, 'develop', remote)
|
||||
|
||||
def prepare_beta_master(repo_path, beta_master, version, remote):
|
||||
g = git.Repo(repo_path).git
|
||||
g.checkout(b=beta_master)
|
||||
|
||||
set_beta_version(repo_path, version)
|
||||
|
||||
def set_beta_version(repo_path, version):
|
||||
from .release import set_filename_version
|
||||
set_filename_version(os.path.join(repo_path, os.path.basename(repo_path),'hooks.py'), version, 'staging_version')
|
||||
|
||||
repo = git.Repo(repo_path)
|
||||
app_name = os.path.basename(repo_path)
|
||||
repo.index.add([os.path.join(app_name, 'hooks.py')])
|
||||
repo.index.commit(f'bumped to version {version}')
|
||||
|
||||
|
||||
def prepare_beta_hotfix(repo_path, beta_hotfix, remote):
|
||||
g = git.Repo(repo_path).git
|
||||
g.checkout(b=beta_hotfix)
|
||||
|
||||
|
||||
def merge_beta_release_to_develop(repo_path, beta_master, remote, version):
|
||||
from .release import handle_merge_error
|
||||
|
||||
repo = git.Repo(repo_path)
|
||||
g = repo.git
|
||||
|
||||
tag_name = 'v' + version
|
||||
repo.create_tag(tag_name, message=f'Release {version}')
|
||||
|
||||
g.checkout('develop')
|
||||
|
||||
try:
|
||||
g.merge(beta_master)
|
||||
except git.exc.GitCommandError as e:
|
||||
handle_merge_error(e, source=beta_master, target='develop')
|
||||
|
||||
return tag_name
|
||||
|
||||
def push_branches(repo_path, beta_master, beta_hotfix, remote):
|
||||
repo = git.Repo(repo_path)
|
||||
g = repo.git
|
||||
|
||||
args = [
|
||||
'develop:develop',
|
||||
f'{beta_master}:{beta_master}',
|
||||
]
|
||||
|
||||
if beta_hotfix:
|
||||
args.append(f'{beta_hotfix}:{beta_hotfix}')
|
||||
|
||||
args.append('--tags')
|
||||
|
||||
print("Pushing branches")
|
||||
print(g.push(remote, *args))
|
||||
|
||||
def create_github_release(repo_path, tag_name, message, owner, remote):
|
||||
from .release import create_github_release
|
||||
|
||||
create_github_release(repo_path, tag_name, message, remote=remote, owner=owner,
|
||||
repo_name=None, gh_username=github_username, gh_password=github_password)
|
||||
367
bench/release.py
367
bench/release.py
@ -1,367 +0,0 @@
|
||||
#! env python
|
||||
import json
|
||||
import os
|
||||
import sys
|
||||
import semantic_version
|
||||
import git
|
||||
import getpass
|
||||
import re
|
||||
from time import sleep
|
||||
|
||||
from bench.exceptions import ValidationError
|
||||
from .config.common_site_config import get_config
|
||||
import click
|
||||
|
||||
branches_to_update = {
|
||||
'develop': [],
|
||||
'version-11-hotfix': [],
|
||||
'version-12-hotfix': [],
|
||||
}
|
||||
|
||||
releasable_branches = ['master']
|
||||
|
||||
github_username = None
|
||||
github_password = None
|
||||
|
||||
def release(bench_path, app, bump_type, from_branch, to_branch,
|
||||
remote='upstream', owner='frappe', repo_name=None, frontport=True):
|
||||
|
||||
confirm_testing()
|
||||
config = get_config(bench_path)
|
||||
|
||||
if not config.get('release_bench'):
|
||||
print('bench not configured to release')
|
||||
sys.exit(1)
|
||||
|
||||
|
||||
if config.get('branches_to_update'):
|
||||
branches_to_update.update(config.get('branches_to_update'))
|
||||
|
||||
if config.get('releasable_branches'):
|
||||
releasable_branches.extend(config.get('releasable_branches',[]))
|
||||
|
||||
validate(bench_path, config)
|
||||
|
||||
bump(bench_path, app, bump_type, from_branch=from_branch, to_branch=to_branch, owner=owner,
|
||||
repo_name=repo_name, remote=remote, frontport=frontport)
|
||||
|
||||
def validate(bench_path, config):
|
||||
import requests
|
||||
from requests.auth import HTTPBasicAuth
|
||||
|
||||
global github_username, github_password
|
||||
|
||||
github_username = config.get('github_username')
|
||||
github_password = config.get('github_password')
|
||||
|
||||
if not github_username:
|
||||
github_username = click.prompt('Username', type=str)
|
||||
|
||||
if not github_password:
|
||||
github_password = getpass.getpass()
|
||||
|
||||
r = requests.get('https://api.github.com/user', auth=HTTPBasicAuth(github_username, github_password))
|
||||
r.raise_for_status()
|
||||
|
||||
def confirm_testing():
|
||||
print('')
|
||||
print('================ CAUTION ==================')
|
||||
print('Never miss this, even if it is a really small release!!')
|
||||
print('Manual Testing Checklisk: https://github.com/frappe/bench/wiki/Testing-Checklist')
|
||||
print('')
|
||||
print('')
|
||||
click.confirm('Is manual testing done?', abort = True)
|
||||
click.confirm('Have you added the change log?', abort = True)
|
||||
|
||||
def bump(bench_path, app, bump_type, from_branch, to_branch, remote, owner, repo_name=None, frontport=True):
|
||||
assert bump_type in ['minor', 'major', 'patch', 'stable', 'prerelease']
|
||||
|
||||
repo_path = os.path.join(bench_path, 'apps', app)
|
||||
push_branch_for_old_major_version(bench_path, bump_type, app, repo_path, from_branch, to_branch, remote, owner)
|
||||
update_branches_and_check_for_changelog(repo_path, from_branch, to_branch, remote=remote)
|
||||
message = get_release_message(repo_path, from_branch=from_branch, to_branch=to_branch, remote=remote)
|
||||
|
||||
if not message:
|
||||
print('No commits to release')
|
||||
return
|
||||
|
||||
print(message)
|
||||
|
||||
click.confirm('Do you want to continue?', abort=True)
|
||||
|
||||
new_version = bump_repo(repo_path, bump_type, from_branch=from_branch, to_branch=to_branch)
|
||||
commit_changes(repo_path, new_version, to_branch)
|
||||
tag_name = create_release(repo_path, new_version, from_branch=from_branch, to_branch=to_branch, frontport=frontport)
|
||||
push_release(repo_path, from_branch=from_branch, to_branch=to_branch, remote=remote)
|
||||
prerelease = True if 'beta' in new_version else False
|
||||
create_github_release(repo_path, tag_name, message, remote=remote, owner=owner, repo_name=repo_name, prerelease=prerelease)
|
||||
print(f'Released {tag_name} for {repo_path}')
|
||||
|
||||
def update_branches_and_check_for_changelog(repo_path, from_branch, to_branch, remote='upstream'):
|
||||
|
||||
update_branch(repo_path, to_branch, remote=remote)
|
||||
update_branch(repo_path, from_branch, remote=remote)
|
||||
|
||||
for branch in branches_to_update[from_branch]:
|
||||
update_branch(repo_path, branch, remote=remote)
|
||||
|
||||
git.Repo(repo_path).git.checkout(from_branch)
|
||||
check_for_unmerged_changelog(repo_path)
|
||||
|
||||
def update_branch(repo_path, branch, remote):
|
||||
print("updating local branch of", repo_path, 'using', remote + '/' + branch)
|
||||
|
||||
repo = git.Repo(repo_path)
|
||||
g = repo.git
|
||||
g.fetch(remote)
|
||||
g.checkout(branch)
|
||||
g.reset('--hard', remote+'/'+branch)
|
||||
|
||||
def check_for_unmerged_changelog(repo_path):
|
||||
current = os.path.join(repo_path, os.path.basename(repo_path), 'change_log', 'current')
|
||||
if os.path.exists(current) and [f for f in os.listdir(current) if f != "readme.md"]:
|
||||
raise Exception("Unmerged change log! in " + repo_path)
|
||||
|
||||
def get_release_message(repo_path, from_branch, to_branch, remote='upstream'):
|
||||
print('getting release message for', repo_path, 'comparing', to_branch, '...', from_branch)
|
||||
|
||||
repo = git.Repo(repo_path)
|
||||
g = repo.git
|
||||
log = g.log(f'{remote}/{to_branch}..{remote}/{from_branch}', '--format=format:%s', '--no-merges')
|
||||
|
||||
if log:
|
||||
return "* " + log.replace('\n', '\n* ')
|
||||
|
||||
def bump_repo(repo_path, bump_type, from_branch, to_branch):
|
||||
current_version = get_current_version(repo_path, to_branch)
|
||||
new_version = get_bumped_version(current_version, bump_type)
|
||||
|
||||
print('bumping version from', current_version, 'to', new_version)
|
||||
|
||||
set_version(repo_path, new_version, to_branch)
|
||||
return new_version
|
||||
|
||||
def get_current_version(repo_path, to_branch):
|
||||
# TODO clean this up!
|
||||
version_key = '__version__'
|
||||
|
||||
if to_branch.lower() in releasable_branches:
|
||||
filename = os.path.join(repo_path, os.path.basename(repo_path), '__init__.py')
|
||||
else:
|
||||
filename = os.path.join(repo_path, os.path.basename(repo_path), 'hooks.py')
|
||||
version_key = 'staging_version'
|
||||
|
||||
with open(filename) as f:
|
||||
contents = f.read()
|
||||
match = re.search(r"^(\s*%s\s*=\s*['\\\"])(.+?)(['\"])(?sm)" % version_key,
|
||||
contents)
|
||||
return match.group(2)
|
||||
|
||||
def get_bumped_version(version, bump_type):
|
||||
v = semantic_version.Version(version)
|
||||
if bump_type == 'major':
|
||||
v.major += 1
|
||||
v.minor = 0
|
||||
v.patch = 0
|
||||
v.prerelease = None
|
||||
|
||||
elif bump_type == 'minor':
|
||||
v.minor += 1
|
||||
v.patch = 0
|
||||
v.prerelease = None
|
||||
|
||||
elif bump_type == 'patch':
|
||||
if v.prerelease == ():
|
||||
v.patch += 1
|
||||
v.prerelease = None
|
||||
|
||||
elif len(v.prerelease) == 2:
|
||||
v.prerelease = ()
|
||||
|
||||
elif bump_type == 'stable':
|
||||
# remove pre-release tag
|
||||
v.prerelease = None
|
||||
|
||||
elif bump_type == 'prerelease':
|
||||
if v.prerelease == ():
|
||||
v.patch += 1
|
||||
v.prerelease = ('beta', '1')
|
||||
|
||||
elif len(v.prerelease) == 2:
|
||||
v.prerelease = ('beta', str(int(v.prerelease[1]) + 1))
|
||||
|
||||
else:
|
||||
raise ValidationError("Something wen't wrong while doing a prerelease")
|
||||
|
||||
else:
|
||||
raise ValidationError("bump_type not amongst [major, minor, patch, prerelease]")
|
||||
|
||||
return str(v)
|
||||
|
||||
def set_version(repo_path, version, to_branch):
|
||||
if to_branch.lower() in releasable_branches:
|
||||
set_filename_version(os.path.join(repo_path, os.path.basename(repo_path),'__init__.py'), version, '__version__')
|
||||
else:
|
||||
set_filename_version(os.path.join(repo_path, os.path.basename(repo_path),'hooks.py'), version, 'staging_version')
|
||||
|
||||
# TODO fix this
|
||||
# set_setuppy_version(repo_path, version)
|
||||
# set_versionpy_version(repo_path, version)
|
||||
# set_hooks_version(repo_path, version)
|
||||
|
||||
# def set_setuppy_version(repo_path, version):
|
||||
# set_filename_version(os.path.join(repo_path, 'setup.py'), version, 'version')
|
||||
#
|
||||
# def set_versionpy_version(repo_path, version):
|
||||
# set_filename_version(os.path.join(repo_path, os.path.basename(repo_path),'__version__.py'), version, '__version__')
|
||||
#
|
||||
# def set_hooks_version(repo_path, version):
|
||||
# set_filename_version(os.path.join(repo_path, os.path.basename(repo_path),'hooks.py'), version, 'app_version')
|
||||
|
||||
def set_filename_version(filename, version_number, pattern):
|
||||
changed = []
|
||||
|
||||
def inject_version(match):
|
||||
before, old, after = match.groups()
|
||||
changed.append(True)
|
||||
return before + version_number + after
|
||||
|
||||
with open(filename) as f:
|
||||
contents = re.sub(r"^(\s*%s\s*=\s*['\\\"])(.+?)(['\"])(?sm)" % pattern,
|
||||
inject_version, f.read())
|
||||
|
||||
if not changed:
|
||||
raise Exception('Could not find %s in %s', pattern, filename)
|
||||
|
||||
with open(filename, 'w') as f:
|
||||
f.write(contents)
|
||||
|
||||
def commit_changes(repo_path, new_version, to_branch):
|
||||
print('committing version change to', repo_path)
|
||||
|
||||
repo = git.Repo(repo_path)
|
||||
app_name = os.path.basename(repo_path)
|
||||
|
||||
if to_branch.lower() in releasable_branches:
|
||||
repo.index.add([os.path.join(app_name, '__init__.py')])
|
||||
else:
|
||||
repo.index.add([os.path.join(app_name, 'hooks.py')])
|
||||
|
||||
repo.index.commit(f'bumped to version {new_version}')
|
||||
|
||||
def create_release(repo_path, new_version, from_branch, to_branch, frontport=True):
|
||||
print('creating release for version', new_version)
|
||||
repo = git.Repo(repo_path)
|
||||
g = repo.git
|
||||
g.checkout(to_branch)
|
||||
try:
|
||||
g.merge(from_branch, '--no-ff')
|
||||
except git.exc.GitCommandError as e:
|
||||
handle_merge_error(e, source=from_branch, target=to_branch)
|
||||
|
||||
tag_name = 'v' + new_version
|
||||
repo.create_tag(tag_name, message=f'Release {new_version}')
|
||||
g.checkout(from_branch)
|
||||
|
||||
try:
|
||||
g.merge(to_branch)
|
||||
except git.exc.GitCommandError as e:
|
||||
handle_merge_error(e, source=to_branch, target=from_branch)
|
||||
|
||||
if frontport:
|
||||
for branch in branches_to_update[from_branch]:
|
||||
print (f"Front porting changes to {branch}")
|
||||
print(f'merging {to_branch} into', branch)
|
||||
g.checkout(branch)
|
||||
try:
|
||||
g.merge(to_branch)
|
||||
except git.exc.GitCommandError as e:
|
||||
handle_merge_error(e, source=to_branch, target=branch)
|
||||
|
||||
return tag_name
|
||||
|
||||
def handle_merge_error(e, source, target):
|
||||
print('-'*80)
|
||||
print(f'Error when merging {source} into {target}')
|
||||
print(e)
|
||||
print('You can open a new terminal, try to manually resolve the conflict/error and continue')
|
||||
print('-'*80)
|
||||
click.confirm('Have you manually resolved the error?', abort=True)
|
||||
|
||||
def push_release(repo_path, from_branch, to_branch, remote='upstream'):
|
||||
print('pushing branches', to_branch, from_branch, 'of', repo_path)
|
||||
repo = git.Repo(repo_path)
|
||||
g = repo.git
|
||||
args = [
|
||||
f'{to_branch}:{to_branch}',
|
||||
f'{from_branch}:{from_branch}'
|
||||
]
|
||||
|
||||
for branch in branches_to_update[from_branch]:
|
||||
print(f'pushing {branch} branch of', repo_path)
|
||||
args.append(f'{branch}:{branch}')
|
||||
|
||||
args.append('--tags')
|
||||
|
||||
print(g.push(remote, *args))
|
||||
|
||||
def create_github_release(repo_path, tag_name, message, remote='upstream', owner='frappe', repo_name=None,
|
||||
gh_username=None, gh_password=None, prerelease=False):
|
||||
import requests
|
||||
import requests.exceptions
|
||||
from requests.auth import HTTPBasicAuth
|
||||
|
||||
print('creating release on github')
|
||||
|
||||
global github_username, github_password
|
||||
if not (gh_username and gh_password):
|
||||
if not (github_username and github_password):
|
||||
raise Exception("No credentials")
|
||||
gh_username = github_username
|
||||
gh_password = github_password
|
||||
|
||||
repo_name = repo_name or os.path.basename(repo_path)
|
||||
data = {
|
||||
'tag_name': tag_name,
|
||||
'target_commitish': 'master',
|
||||
'name': 'Release ' + tag_name,
|
||||
'body': message,
|
||||
'draft': False,
|
||||
'prerelease': prerelease
|
||||
}
|
||||
for i in range(3):
|
||||
try:
|
||||
r = requests.post(f'https://api.github.com/repos/{owner}/{repo_name}/releases',
|
||||
auth=HTTPBasicAuth(gh_username, gh_password), data=json.dumps(data))
|
||||
r.raise_for_status()
|
||||
break
|
||||
except requests.exceptions.HTTPError:
|
||||
print('request failed, retrying....')
|
||||
sleep(3*i + 1)
|
||||
if i !=2:
|
||||
continue
|
||||
else:
|
||||
print(r.json())
|
||||
raise
|
||||
return r
|
||||
|
||||
def push_branch_for_old_major_version(bench_path, bump_type, app, repo_path, from_branch, to_branch, remote, owner):
|
||||
if bump_type != 'major':
|
||||
return
|
||||
|
||||
current_version = get_current_version(repo_path)
|
||||
old_major_version_branch = f"v{current_version.split('.')[0]}.x.x"
|
||||
|
||||
click.confirm(f'Do you want to push {old_major_version_branch}?', abort=True)
|
||||
|
||||
update_branch(repo_path, to_branch, remote=remote)
|
||||
|
||||
g = git.Repo(repo_path).git
|
||||
g.checkout(b=old_major_version_branch)
|
||||
|
||||
args = [
|
||||
f'{old_major_version_branch}:{old_major_version_branch}',
|
||||
]
|
||||
|
||||
print(f"Pushing {old_major_version_branch} ")
|
||||
print(g.push(remote, *args))
|
||||
Loading…
Reference in New Issue
Block a user