feat: add several utility functions and bits of logic to ensure branches are synced before scripts run

Author: 56kyle

scripts/lint-from-demo.py

@@ -5,6 +5,8 @@
 import typer
 from retrocookie.core import retrocookie
 
+from scripts.util import is_repo_clean_and_up_to_date
+from scripts.util import require_clean_and_up_to_date_repo
 from util import git
 from util import FolderOption
 from util import in_new_demo
@@ -32,7 +34,7 @@ def lint_from_demo(
         add_rust_extension=add_rust_extension,
         no_cache=no_cache
     ) as demo_path:
-        git("status", "--porcelain")
+        require_clean_and_up_to_date_repo()
         git("checkout", "develop")
         git("branch", "-D", "temp/lint-from-demo", ignore_error=True)
         git("checkout", "-b", "temp/lint-from-demo", "develop")

scripts/update-demo.py

@@ -6,6 +6,8 @@
 import typer
 from cookiecutter.utils import work_in
 
+from scripts.util import is_repo_clean_and_up_to_date
+from scripts.util import require_clean_and_up_to_date_repo
 from util import get_demo_name
 from util import git
 from util import FolderOption
@@ -26,7 +28,7 @@ def update_demo(
         demo_path: Path = demos_cache_folder / demo_name
         typer.secho(f"Updating demo project at {demo_path=}.", fg="yellow")
         with work_in(demo_path):
-            git("status", "--porcelain")
+            require_clean_and_up_to_date_repo()
             cruft.update(
                 project_dir=demo_path,
                 template_path=REPO_FOLDER,

scripts/util.py

@@ -17,7 +17,6 @@
 import cruft
 import typer
 from cookiecutter.utils import work_in
-from pygments.lexers import q
 from typer.models import OptionInfo
 
 
@@ -65,6 +64,39 @@ def run_command(command: str, *args: str, ignore_error: bool = False) -> Optiona
 uv: partial[subprocess.CompletedProcess] = partial(run_command, "uv")
 
 
+def require_clean_and_up_to_date_repo() -> None:
+    """Checks if the repo is clean and up to date with any important branches."""
+    if not is_repo_clean_and_up_to_date():
+        typer.secho("The repo is either not clean or is not up to date.", fg="red")
+        raise typer.Exit(code=1)
+
+
+def is_repo_clean_and_up_to_date() -> bool:
+    """Checks if the repo is clean and up to date with any important branches."""
+    try:
+        git("fetch")
+        git("status", "--porcelain")
+        if not is_branch_synced_with_remote("develop"):
+            raise ValueError("develop is not synced with origin/develop")
+        if not is_branch_synced_with_remote("main"):
+            raise ValueError("main is not synced with origin/main")
+        if not is_ancestor("main", "develop"):
+            raise ValueError("main is not an ancestor of develop")
+        return True
+    except subprocess.CalledProcessError:
+        return False
+
+
+def is_branch_synced_with_remote(branch: str) -> bool:
+    """Checks if the branch is synced with its remote."""
+    return is_ancestor(branch, f"origin/{branch}") and is_ancestor(f"origin/{branch}", branch)
+
+
+def is_ancestor(ancestor: str, descendent: str) -> bool:
+    """Checks if the branch is synced with its remote."""
+    return git("merge-base", "--is-ancestor", ancestor, descendent).returncode == 0
+
+
 @contextmanager
 def in_new_demo(
     demos_cache_folder: Path,