opensearch-pyd/utils/changelog_updater.py

# SPDX-License-Identifier: Apache-2.0
#
# The OpenSearch Contributors require contributions made to
# this file be licensed under the Apache-2.0 license or a
# compatible open source license.
#
# Modifications Copyright OpenSearch Contributors. See
# GitHub history for details.

import subprocess

import requests


def main() -> None:
    """
    Update CHANGELOG.md when API generator produces new code differing from existing.
    """
    git_command = "git status"
    try:
        git_status = subprocess.check_output(
            git_command, shell=True, stderr=subprocess.STDOUT
        )
        if (
            "Changes to be committed:" in git_status.decode()
            or "Changes not staged for commit:" in git_status.decode()
            or "Untracked files:" in git_status.decode()
        ):
            print("Changes detected; updating changelog.")

            base_url = "https://api.github.com/repos/opensearch-project/opensearch-api-specification/commits"
            url_with_per_page = base_url + "?per_page=1"
            response = requests.get(url_with_per_page)
            if response.ok:
                commit_info = response.json()[0]
                commit_url = commit_info["html_url"]
                latest_commit_sha = commit_info.get("sha")
            else:
                raise Exception(
                    f"Failed to fetch opensearch-api-specification commit information. Status code: {response.status_code}"
                )

            with open("CHANGELOG.md", "r+", encoding="utf-8") as file:
                content = file.read()
                if commit_url not in content:
                    if "### Updated APIs" in content:
                        file_content = content.replace(
                            "### Updated APIs",
                            f"### Updated APIs\n- Updated opensearch-py APIs to reflect [opensearch-api-specification@{latest_commit_sha[:7]}]({commit_url})",
                            1,
                        )
                        file.seek(0)
                        file.write(file_content)
                        file.truncate()
                    else:
                        raise Exception(
                            "'Updated APIs' section is not present in CHANGELOG.md"
                        )
        else:
            print("No changes detected")

    except subprocess.CalledProcessError as e:
        print(f"Error occurred while checking Git status: {e}")


if __name__ == "__main__":
    main()