release_notes.py

import os
import re
import subprocess
import sys

SYSTEM_COMMIT_PATTERNS = [
    'Increase maintenance version', 'updated packages', '\[skip ci\]'
]


def show_usage(exit_code=0):
    print('Usage:')
    print("python release_notes.py <from_version> <to_version> <verbose>")
    exit(exit_code)


def throw_error():
    print("Bad args...")
    show_usage(os.EX_USAGE)


def run_shell_cmd(cmd):
    return subprocess.check_output(cmd, shell=True).decode('utf-8')


def system_commit_patterns_grep_statement():
    statement = "--invert-grep"
    for pattern in SYSTEM_COMMIT_PATTERNS:
        statement += " --grep='{}'".format(pattern)
    return statement


def commits_with_issue_number_grep_statement():
    return "--grep='OpenConceptLab/ocl_issues'"


def get_commit_sha_from_message(message):
    return run_shell_cmd("git log --oneline --grep={} --format=format:%H".format(message)).split('\n')[0]


def get_release_date(message):
    return run_shell_cmd("git log --oneline --grep={} --format=format:%ad".format(message))


def get_commits(from_sha, to_sha, verbose=True, remove_system_commits=True):
    commits_list_cmd = "git log {}..{} --pretty=format:'%s'".format(from_sha, to_sha)
    if verbose:
        if remove_system_commits:
            commits_list_cmd += " " + system_commit_patterns_grep_statement()
    else:
        commits_list_cmd += " " + commits_with_issue_number_grep_statement()

    return format_commits(run_shell_cmd(commits_list_cmd).split('\n'))


def get_issue_url(issue_number):
    return "https://github.com/OpenConceptLab/ocl_issues/issues/{}".format(issue_number)


def format_commits(commits):
    issue_number_regex = re.compile('\#\d+')
    result = []
    for commit in commits:
        if commit.startswith('OpenConceptLab/ocl_issues'):
            issue_number = issue_number_regex.search(commit).group()
            if issue_number:
                prefix = 'OpenConceptLab/ocl_issues' + issue_number
                suffix = commit.split(prefix)[1]
                issue_number = issue_number.replace('#', '')
                result.append("[{}]({}){}".format(prefix, get_issue_url(issue_number), suffix))
            else:
                result.append(commit)

        else:
            result.append(commit)
    return result


def format_md(value, heading_level=None):
    if isinstance(value, list):
        value = [v for v in value if v]
        return '- ' + '\n- '.join(value) if value else 'No changelog'

    if heading_level and isinstance(heading_level, int) and 6 >= heading_level >= 1:
        return "#" * heading_level + ' ' + value

    return value


def run():
    try:
        if 'help' in sys.argv:
            show_usage()
            return

        from_message = sys.argv[1]
        to_message = sys.argv[2]
        is_verbose = len(sys.argv) > 3 and sys.argv[3] in [True, 'true', 'True']
        iterate_interim_versions = True

        if not from_message or not to_message:
            throw_error()

        batches = []
        if iterate_interim_versions:
             from_minor_version = int(from_message.split('.')[-1])
             to_minor_version = int(to_message.split('.')[-1])
             next_minor_version = from_minor_version + 1
             prefix = '.'.join(from_message.split('.')[:-1])
             order = 1
             while next_minor_version <= to_minor_version:
                 from_tag = prefix + '.' + str(from_minor_version)
                 to_tag = prefix + '.' + str(next_minor_version)
                 from_sha = get_commit_sha_from_message(from_tag)
                 to_sha = get_commit_sha_from_message(to_tag)

                 if from_sha and to_sha:
                     commits = get_commits(from_sha, to_sha, is_verbose)
                     commits = [commit for commit in commits if commit]
                     if commits:
                         release_date = get_release_date(to_tag)
                         batches.append({
                             'heading': format_md(value=f"{to_tag} - {release_date}", heading_level=5),
                             'commits': format_md(value=commits),
                             'order': order
                         })

                 from_minor_version = next_minor_version
                 next_minor_version += 1
                 order += 1

        for batch in sorted(batches, key=lambda b: b['order'], reverse=True):
            print(batch['heading'])
            print(batch['commits'])

    except Exception:
        throw_error()


run()