INNER CODE UNIT · Python

sync_readme

Teycir/BurpAPISecuritySuite · scripts/sync_readme_updates.py:103

def sync_readme(changelog_path: Path, readme_path: Path, releases_count: int) -> int:
    changelog_text = changelog_path.read_text(encoding="utf-8")
    readme_text = readme_path.read_text(encoding="utf-8")

    releases = parse_changelog(changelog_text, max_releases=releases_count)
    if not releases:
        raise ValueError("No releases found in changelog.")

    rendered_block = render_recent_updates(releases)
    updated_readme = replace_managed_block(readme_text, rendered_block)

    if updated_readme != readme_text:
        readme_path.write_text(updated_readme, encoding="utf-8")
        return 1
    return 0


def build_parser() -> argparse.ArgumentParser:

View source record →