Function check_index_in_sync_with_readme

scripts/check_generated_artifacts.py:223–284

Verify index.md matches the README.md body under the Jekyll front matter. README.md is the canonical source for the project overview; index.md is the Jekyll-rendered version with a YAML front matter block prepended. The sync_index_from_readme.py script regenerates index.md from README.m

()

def check_index_in_sync_with_readme() -> int:
    """Verify index.md matches the README.md body under the Jekyll front matter.

    README.md is the canonical source for the project overview; index.md
    is the Jekyll-rendered version with a YAML front matter block prepended.
    The sync_index_from_readme.py script regenerates index.md from README.md.
    This check fails the build if the two have drifted.
    """

    if not repo_path(SYNC_INDEX_SCRIPT).is_file():
        print(
            f"No sync script found at {display_path(SYNC_INDEX_SCRIPT)}. "
            "Skipping index.md / README.md sync check."
        )
        return 0

    if not repo_path(INDEX_MD).is_file() or not repo_path(README_MD).is_file():
        print(
            "FAILED: Expected README.md and index.md to both exist for the sync check."
        )
        return 1

    original_index_contents = read_bytes(INDEX_MD)
    exit_code = 0

    try:
        subprocess.run(
            [sys.executable, str(repo_path(SYNC_INDEX_SCRIPT))],
            cwd=repo_root(),
            check=True,
        )

        regenerated_index = read_bytes(INDEX_MD)
        expected_lines = raw_text_lines(original_index_contents)
        actual_lines = raw_text_lines(regenerated_index)

        if expected_lines != actual_lines:
            print_diff(
                "FAILED: index.md is out of sync with README.md. "
                "Run scripts/sync_index_from_readme.py to regenerate it.",
                expected_lines=expected_lines,
                actual_lines=actual_lines,
                expected_name="committed index.md",
                actual_name="regenerated index.md",
            )
            exit_code = 1
    except subprocess.CalledProcessError as exc:
        print(
            f"FAILED: sync_index_from_readme.py exited with status {exc.returncode}."
        )
        exit_code = 1
    except Exception as exc:
        print(f"FAILED: index.md / README.md sync check could not complete: {exc}")
        exit_code = 1
    finally:
        restore_errors = restore_original_files({INDEX_MD: original_index_contents})
        if restore_errors:
            for message in restore_errors: