feat: add a ton of half finished logic for release handling that will be refactored soon

Author: 56kyle

.env

@@ -2,10 +2,22 @@
 # Users can override these by creating a .env.local file (not committed to git)
 
 # App author name used for cache directory paths
-COOKIECUTTER_ROBUST_PYTHON_APP_AUTHOR=robust-python
+COOKIECUTTER_ROBUST_PYTHON__DEMOS_CACHE_FOLDER=""
 
-# Main branch name (typically used for stable releases)
-COOKIECUTTER_ROBUST_PYTHON_MAIN_BRANCH=main
+COOKIECUTTER_ROBUST_PYTHON__APP_NAME="cookiecutter-robust-python"
+COOKIECUTTER_ROBUST_PYTHON__APP_AUTHOR="robust-python"
+COOKIECUTTER_ROBUST_PYTHON__REMOTE="origin"
+COOKIECUTTER_ROBUST_PYTHON__MAIN_BRANCH="main"
+COOKIECUTTER_ROBUST_PYTHON__DEVELOP_BRANCH="develop"
 
-# Development branch name (where feature development occurs)
-COOKIECUTTER_ROBUST_PYTHON_DEVELOP_BRANCH=develop
+ROBUST_PYTHON_DEMO__APP_NAME="robust-python-demo"
+ROBUST_PYTHON_DEMO__APP_AUTHOR="robust-python"
+ROBUST_PYTHON_DEMO__REMOTE="origin"
+ROBUST_PYTHON_DEMO__MAIN_BRANCH="main"
+ROBUST_PYTHON_DEMO__DEVELOP_BRANCH="develop"
+
+ROBUST_MATURIN_DEMO__APP_NAME="robust-maturin-demo"
+ROBUST_MATURIN_DEMO__APP_AUTHOR="robust-python"
+ROBUST_MATURIN_DEMO__REMOTE="origin"
+ROBUST_MATURIN_DEMO__MAIN_BRANCH="main"
+ROBUST_MATURIN_DEMO__DEVELOP_BRANCH="develop"

noxfile.py

@@ -6,6 +6,7 @@
 
 import os
 import shutil
+from dataclasses import dataclass
 from pathlib import Path
 
 import nox
@@ -66,6 +67,25 @@
 )
 
 
+@dataclass
+class RepoMetadata:
+    """Metadata for a given repo."""
+    app_name: str
+    app_author: str
+    remote: str
+    main_branch: str
+    develop_branch: str
+
+
+TEMPLATE: RepoMetadata = RepoMetadata(
+    app_name=os.getenv("COOKIECUTTER_ROBUST_PYTHON__APP_NAME"),
+    app_author=os.getenv("COOKIECUTTER_ROBUST_PYTHON__APP_AUTHOR"),
+    remote=os.getenv("COOKIECUTTER_ROBUST_PYTHON__REMOTE"),
+    main_branch=os.getenv("COOKIECUTTER_ROBUST_PYTHON__MAIN_BRANCH"),
+    develop_branch=os.getenv("COOKIECUTTER_ROBUST_PYTHON__DEVELOP_BRANCH")
+)
+
+
 @nox.session(python=DEFAULT_TEMPLATE_PYTHON_VERSION, name="generate-demo")
 def generate_demo(session: Session) -> None:
     """Generates a project demo using the cookiecutter-robust-python template."""
@@ -103,6 +123,7 @@ def lint_from_demo(session: Session):
     session.log("Installing linting dependencies for the generated project...")
     session.install("-e", ".", "--group", "dev", "--group", "lint")
     session.run("python", LINT_FROM_DEMO_SCRIPT, *LINT_FROM_DEMO_OPTIONS, *session.posargs)
+    session.install_and_run_script()
 
 
 @nox.session(python=DEFAULT_TEMPLATE_PYTHON_VERSION)

scripts/release-demo.py

@@ -1,23 +1,30 @@
 # /// script
 # requires-python = ">=3.10"
 # dependencies = [
-#     cookiecutter,
-#     cruft,
-#     typer,
+#    "cookiecutter",
+#    "cruft",
+#    "python-dotenv",
+#    "typer",
 # ]
 # ///
+import itertools
+import subprocess
 from pathlib import Path
 from typing import Annotated
 
 import typer
 from cookiecutter.utils import work_in
+from loguru import logger
 
+from util import get_current_branch
 from util import get_demo_name
+from util import gh
 from util import git
-from util import is_ancestor
-from util import uv
-from util import validate_is_synced_ancestor
+from util import nox
+from util import require_clean_and_up_to_date_repo
 from util import FolderOption
+from util import RepoMetadata
+from util import DEMO
 
 
 cli: typer.Typer = typer.Typer()
@@ -26,25 +33,51 @@
 @cli.callback(invoke_without_command=True)
 def release_demo(
     demos_cache_folder: Annotated[Path, FolderOption("--demos-cache-folder", "-c")],
-    min_python_version: Annotated[str, typer.Option("--min-python-version")],
-    max_python_version: Annotated[str, typer.Option("--max-python-version")],
     add_rust_extension: Annotated[bool, typer.Option("--add-rust-extension", "-r")] = False
 ) -> None:
     """Creates a release of the demo's current develop branch if changes exist."""
     demo_name: str = get_demo_name(add_rust_extension=add_rust_extension)
     demo_path: Path = demos_cache_folder / demo_name
 
+    with work_in(demo_path):
+        require_clean_and_up_to_date_repo()
+        git("checkout", DEMO.develop_branch)
+        try:
+            nox("setup-release", "--", "MINOR")
+            logger.success(f"Successfully created release {demo_name}")
+            _ensure_github_repo_set(repo=DEMO)
 
+        except subprocess.CalledProcessError as error:
+            logger.warning(f"Failed to setup release: {error}")
+            _rollback_failed_release()
+            raise error
 
+        git("push", "-u")
+        _create_demo_pr(version=)
 
-def _validate_demo_develop_up_to_date(demo_path: Path) -> None:
-    """Ensures the demo's develop branch is up to date."""
-    with work_in(demo_path):
-        validate_is_synced_ancestor(ancestor=)
+
+def _ensure_github_repo_set(repo: RepoMetadata) -> None:
+    """Ensures the repo has a github repo set."""
+    gh("repo", "set-default", repo.app_author, repo.app_name)
 
 
+def _rollback_failed_release() -> None:
+    """Returns the demo repo back to the state it was prior to the release attempt."""
+    starting_demo_branch: str = get_current_branch()
 
+    if starting_demo_branch != "develop":
+        git("checkout", DEMO.develop_branch)
 
+    git("checkout", ".")
+    git("branch", "-D", starting_demo_branch)
 
 
+def _create_demo_pr(version: str) -> None:
+    """Creates a pull request to merge the demo's feature branch into ."""
+    pr_kwargs: dict[str, str] = {
+        "--title": f"Release/{version}"
+    }
+    publish_release_commands: list[list[str]] = [
+        ["gh", "pr", "create", *itertools.chain(pr_kwargs.items())],
+    ]
 

scripts/util.py

@@ -16,13 +16,15 @@
 import subprocess
 import sys
 from contextlib import contextmanager
+from dataclasses import dataclass
 from functools import partial
 from pathlib import Path
 from typing import Any
 from typing import Callable
 from typing import Generator
 from typing import Literal
 from typing import Optional
+from typing import TypedDict
 from typing import overload
 
 import cruft
@@ -60,8 +62,31 @@ def _load_env() -> None:
 )
 
 
-MAIN_BRANCH: str = os.getenv("COOKIECUTTER_ROBUST_PYTHON_MAIN_BRANCH", "main")
-DEVELOP_BRANCH: str = os.getenv("COOKIECUTTER_ROBUST_PYTHON_DEVELOP_BRANCH", "develop")
+@dataclass
+class RepoMetadata:
+    """Metadata for a given repo."""
+    app_name: str
+    app_author: str
+    remote: str
+    main_branch: str
+    develop_branch: str
+
+
+TEMPLATE: RepoMetadata = RepoMetadata(
+    app_name=os.getenv("COOKIECUTTER_ROBUST_PYTHON__APP_NAME"),
+    app_author=os.getenv("COOKIECUTTER_ROBUST_PYTHON__APP_AUTHOR"),
+    remote=os.getenv("COOKIECUTTER_ROBUST_PYTHON__REMOTE"),
+    main_branch=os.getenv("COOKIECUTTER_ROBUST_PYTHON__MAIN_BRANCH"),
+    develop_branch=os.getenv("COOKIECUTTER_ROBUST_PYTHON__DEVELOP_BRANCH")
+)
+
+DEMO: RepoMetadata = RepoMetadata(
+    app_name=os.getenv("ROBUST_DEMO__APP_NAME"),
+    app_author=os.getenv("ROBUST_DEMO__APP_AUTHOR"),
+    remote=os.getenv("ROBUST_DEMO__REMOTE"),
+    main_branch=os.getenv("ROBUST_DEMO__MAIN_BRANCH"),
+    develop_branch=os.getenv("ROBUST_DEMO__DEVELOP_BRANCH")
+)
 
 
 def remove_readonly(func: Callable[[str], Any], path: str, _: Any) -> None:
@@ -93,18 +118,20 @@ def run_command(command: str, *args: str, ignore_error: bool = False) -> Optiona
             return None
         print(error.stdout, end="")
         print(error.stderr, end="", file=sys.stderr)
-        raise
+        raise error
 
 
 git: partial[subprocess.CompletedProcess] = partial(run_command, "git")
 uv: partial[subprocess.CompletedProcess] = partial(run_command, "uv")
+nox: partial[subprocess.CompletedProcess] = partial(run_command, "nox")
+gh: partial[subprocess.CompletedProcess] = partial(run_command, "gh")
 
 
 def require_clean_and_up_to_date_repo() -> None:
     """Checks if the repo is clean and up to date with any important branches."""
     git("fetch")
     git("status", "--porcelain")
-    validate_is_synced_ancestor(ancestor=MAIN_BRANCH, descendent=DEVELOP_BRANCH)
+    validate_is_synced_ancestor(ancestor=DEMO.main_branch, descendent=DEMO.develop_branch)
 
 
 def validate_is_synced_ancestor(ancestor: str, descendent: str) -> None:

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

@@ -4,13 +4,13 @@
 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
 from util import create_release_branch
 from util import get_bumped_package_version
 from util import get_package_version
+from util import require_clean_and_up_to_date_repo
 
 
 def main() -> None:
@@ -21,9 +21,9 @@ def main() -> None:
 
 
 def get_parser() -> argparse.ArgumentParser:
-    """Creates the argument parser for prepare-release."""
+    """Creates the argument parser for setup-release."""
     parser: argparse.ArgumentParser = argparse.ArgumentParser(
-        prog="prepare-release", usage="python ./scripts/prepare-release.py patch"
+        prog="setup-release", usage="python ./scripts/setup-release.py patch"
     )
     parser.add_argument(
         "increment",