Function bump_version_changelog_md

commands.py:395–436

Bump the version in CHANGELOG.md to new_version and date to new_date Returns True on success, False on failure

(new_version, new_date)

def bump_version_changelog_md(new_version, new_date):
    """
    Bump the version in CHANGELOG.md to new_version and date to new_date
    Returns True on success, False on failure
    """
    changelog_md_path = "CHANGELOG.md"
    pattern = r"(^\s*##\s*Unreleased\s*$)"
    new_header = f"\n\n## [{new_version}] - {new_date}\n"

    with open(changelog_md_path, "r") as f:
        content = f.read()

    # Check if the header already exists, so that we don't add a double header
    already_exists_pattern = rf"(^\s*##\s*\[ *{re.escape(new_version)} *\])"
    if re.search(already_exists_pattern, content, flags=re.MULTILINE):
        print(
            f"Header for version {new_version} already exists",
            f"in {changelog_md_path}.",
        )
        return True

    new_content, n_subs = re.subn(
        pattern,
        rf"\g<1>{new_header}",
        content,
        count=1,  # replace only the first match
        flags=re.MULTILINE,
    )
    if n_subs < 1:
        print(
            f"FAILED to update version in {changelog_md_path}.",
            "Please update manually.",
        )
        return False

    with open(changelog_md_path, "w") as f:
        f.write(new_content)
    print(
        f"Added header in {changelog_md_path} with version {new_version}",
        f"and release date {new_date}",
    )
    return True


def bump_version(args):