feat: add a check to the setup-release script in generated project along with light refactors

Author: 56kyle

{{cookiecutter.project_name}}/scripts/setup-release.py

@@ -4,6 +4,7 @@
 import subprocess
 from typing import Optional
 
+from scripts.util import require_clean_and_up_to_date_repo
 from util import REPO_FOLDER
 from util import bump_version
 from util import check_dependencies
@@ -42,6 +43,7 @@ def setup_release(increment: Optional[str] = None) -> None:
     release or push any changes.
     """
     check_dependencies(path=REPO_FOLDER, dependencies=["git"])
+    require_clean_and_up_to_date_repo()
 
     current_version: str = get_package_version()
     new_version: str = get_bumped_package_version(increment=increment)

{{cookiecutter.project_name}}/scripts/util.py

@@ -10,6 +10,8 @@
 
 
 REPO_FOLDER: Path = Path(__file__).resolve().parent.parent
+MAIN_BRANCH: str = "main"
+DEVELOP_BRANCH: str = "develop"
 
 
 class MissingDependencyError(Exception):
@@ -34,6 +36,22 @@ def check_dependencies(path: Path, dependencies: list[str]) -> None:
             raise MissingDependencyError(path, dependency) from e
 
 
+def require_clean_and_up_to_date_repo() -> None:
+    """Checks if the repo is clean and up to date with any important branches."""
+    commands: list[list[str]] = [
+        ["git", "fetch"],
+        ["git", "merge-base", "--is-ancestor", MAIN_BRANCH, f"origin/{MAIN_BRANCH}"],
+        ["git", "merge-base", "--is-ancestor", f"origin/{MAIN_BRANCH}", MAIN_BRANCH],
+        ["git", "merge-base", "--is-ancestor", DEVELOP_BRANCH, f"origin/{DEVELOP_BRANCH}"],
+        ["git", "merge-base", "--is-ancestor", f"origin/{DEVELOP_BRANCH}", DEVELOP_BRANCH],
+        ["git", "merge-base", "--is-ancestor", MAIN_BRANCH, DEVELOP_BRANCH],
+        ["git", "status", "--porcelain"],
+    ]
+
+    for command in commands:
+        subprocess.run(command, cwd=REPO_FOLDER, check=True)
+
+
 def existing_dir(value: str) -> Path:
     """Responsible for validating argparse inputs and returning them as pathlib Path's if they meet criteria."""
     path = Path(value).expanduser().resolve()