make_release.py

#!/usr/bin/env python3 -u
# coding: utf-8
"""
Do-nothing script for making a release

This idea comes from here:
- https://blog.danslimmon.com/2019/07/15/do-nothing-scripting-the-key-to-gradual-automation/

The script is adapted from:
- https://github.com/alan-turing-institute/CleverCSV/blob/master/make_release.py
"""

__author__ = ["Markus Löning"]

import codecs
import os
import re
import webbrowser

import colorama

ROOTDIR = os.path.abspath(os.path.dirname(__file__)).strip("maint_tools")
PACKAGE_NAME = "sktime-dl"
URLS = {
    "pypi": f"https://pypi.org/simple/{PACKAGE_NAME}/"
}


def read(*parts):
    # intentionally *not* adding an encoding option to open, See:
    #   https://github.com/pypa/virtualenv/issues/201#issuecomment-3145690
    with codecs.open(os.path.join(ROOTDIR, *parts), 'r') as fp:
        return fp.read()


def find_version(*file_paths):
    version_file = read(*file_paths)
    version_match = re.search(r"^__version__ = ['\"]([^'\"]*)['\"]",
                              version_file, re.M)
    if version_match:
        return version_match.group(1)
    else:
        raise RuntimeError("Unable to find version string.")


def open_website(website):
    webbrowser.open(website, new=1)


def colored(msg, color=None, style=None):
    colors = {
        "red": colorama.Fore.RED,
        "green": colorama.Fore.GREEN,
        "cyan": colorama.Fore.CYAN,
        "yellow": colorama.Fore.YELLOW,
        "magenta": colorama.Fore.MAGENTA,
        None: "",
    }
    styles = {
        "bright": colorama.Style.BRIGHT,
        "dim": colorama.Style.DIM,
        None: "",
    }
    pre = colors[color] + styles[style]
    post = colorama.Style.RESET_ALL
    return f"{pre}{msg}{post}"


def cprint(msg, color=None, style=None):
    """Coloured printing"""
    print(colored(msg, color=color, style=style))


def wait_for_enter():
    input(colored("\nPress Enter to continue", style="dim"))
    print()


class Step:

    def pre(self, context):
        pass

    def post(self, context):
        wait_for_enter()

    def run(self, context):
        try:
            self.pre(context)
            self.action(context)
            self.post(context)
        except KeyboardInterrupt:
            cprint("\nInterrupted.", color="red")
            raise SystemExit(1)

    @staticmethod
    def instruct(msg):
        cprint(msg, color="green")

    def print_run(self, msg):
        cprint("Run:", color="cyan", style="bright")
        self.print_cmd(msg)

    @staticmethod
    def print_cmd(msg):
        cprint("\t" + msg, color="cyan", style="bright")

    @staticmethod
    def do_cmd(cmd):
        cprint(f"Going to run: {cmd}", color="magenta", style="bright")
        wait_for_enter()
        os.system(cmd)

    def action(self, context):
        raise NotImplementedError("abstract method")


class ConfirmGitStatus(Step):
    def action(self, context):
        self.instruct("Make sure you're on master and changes are merged in")
        self.print_run("git checkout master")


class RunTests(Step):
    def action(self, context):
        self.do_cmd("make test")


class RunLinting(Step):
    def action(self, context):
        self.do_cmd("make lint")


class UpdateChangelog(Step):
    def action(self, context):
        self.instruct(f"Update CHANGELOG for version: {context['version']}")


class BumpVersion(Step):
    def action(self, context):
        self.instruct(f"Update __init__.py with new version")

    def post(self, context):
        wait_for_enter()
        context["version"] = find_version(context['package_name'],
                                          '__init__.py')


class MakeClean(Step):
    def action(self, context):
        self.do_cmd("make clean")


class MakeDist(Step):
    def action(self, context):
        self.do_cmd("make dist")


class PushToTestPyPI(Step):
    def action(self, context):
        self.do_cmd(
            "twine upload --repository-url https://test.pypi.org/legacy/ dist/*"
        )


class InstallFromTestPyPI(Step):
    def action(self, context):
        self.instruct(
            f"Check installation from TestPyPI"
        )
        self.print_run("cd /tmp/")
        self.print_cmd("rm -rf ./venv")
        self.print_cmd("virtualenv ./venv")
        self.print_cmd("source ./venv/bin/activate")
        self.print_cmd(
            "pip install --index-url https://test.pypi.org/simple/ "
            "--extra-index-url https://pypi.org/simple {context['package_name']}=={context['version']}"
        )


class CheckVersionNumber(Step):
    def action(self, context):
        self.instruct(
            f"Ensure that the following command gives version: {context['version']}"
        )
        self.do_cmd(
            f"python -c 'import {context['package_name']}; print({context['package_name']}.__version__)'")


class DeactivateVenv(Step):
    def action(self, context):
        self.print_run("deactivate")
        self.instruct("Go back to the project directory")


class GitTagVersion(Step):
    def action(self, context):
        self.do_cmd(f"git tag v{context['version']}")


class GitTagPreRelease(Step):
    def action(self, context):
        self.instruct("Tag version as a pre-release (increment as needed)")
        self.print_run(f"git tag v{context['version']}-rc.1")


class GitAddCommit(Step):
    def action(self, context):
        self.instruct("Add everything to git and commit")


class GitAddRelease(Step):
    def action(self, context):
        self.instruct("Add CHANGELOG & README to git")
        self.instruct(
            f"Commit with title: {context['package_name']} {context['version']}"
        )


class PushToPyPI(Step):
    def action(self, context):
        self.do_cmd("twine upload dist/*")


class PushToGitHub(Step):
    def action(self, context):
        self.do_cmd("git push -u --tags origin master")


class CheckCIStatus(Step):
    def action(self, context):
        self.instruct(
            "Wait for CI to complete and check status"
        )


class CheckPyPIFiles(Step):
    def action(self, context):
        self.instruct(
            "Check PyPI files"
        )
        open_website(URLS["pypi"])


def main():
    colorama.init()
    steps = [
        ConfirmGitStatus(),
        MakeClean(),
        RunLinting(),
        RunTests(),
        PushToGitHub(),  # trigger CI to run tests
        CheckCIStatus(),
        BumpVersion(),
        GitAddCommit(),
        GitTagPreRelease(),
        PushToGitHub(),  # trigger CI to run tests
        CheckCIStatus(),
        UpdateChangelog(),
        MakeClean(),
        MakeDist(),
        PushToTestPyPI(),
        InstallFromTestPyPI(),
        CheckVersionNumber(),
        DeactivateVenv(),
        GitAddRelease(),
        PushToPyPI(),
        GitTagVersion(),
        PushToGitHub(),  # triggers Travis to build and deploy on tag
        CheckCIStatus(),
        CheckPyPIFiles()
    ]
    context = dict()
    context["package_name"] = PACKAGE_NAME
    for step in steps:
        step.run(context)
    cprint("\nDone!", color="yellow", style="bright")


if __name__ == "__main__":
    main()