multi-workspace 3.2.8__tar.gz → 3.2.10__tar.gz

{multi_workspace-3.2.8 → multi_workspace-3.2.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: multi-workspace
-Version: 3.2.8
+Version: 3.2.10
 Summary: Multi
 Project-URL: Repository, https://github.com/gabemontague/multi
 Project-URL: Issues, https://github.com/gabemontague/multi/issues

{multi_workspace-3.2.8 → multi_workspace-3.2.10}/multi/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '3.2.8'
-__version_tuple__ = version_tuple = (3, 2, 8)
+__version__ = version = '3.2.10'
+__version_tuple__ = version_tuple = (3, 2, 10)
 
 __commit_id__ = commit_id = None

multi_workspace-3.2.10/multi/branch.py

@@ -0,0 +1,66 @@
+import logging
+from pathlib import Path
+
+import click
+
+from multi.errors import GitError
+from multi.git_helpers import describe_head
+from multi.paths import Paths
+from multi.repos import load_repos
+
+logger = logging.getLogger(__name__)
+
+
+def report_branches(paths: Paths) -> bool:
+    """Log the current branch of the root repo and each sub-repo.
+
+    Read-only: works with dirty working trees, mismatched branches, detached
+    HEADs (for example in worktrees created by `multi worktree add`), and
+    sub-repos that have not been synced yet (reported as missing).
+    Returns True when every repo is present and on its expected branch.
+    """
+    root_branch = describe_head(paths.root_dir)
+    logger.info(f"{paths.root_dir.name} (root): {root_branch}")
+
+    if paths.settings.is_monorepo():
+        # Sub-repos are part of the root repo in monorepo mode.
+        return True
+
+    all_match = True
+    for repo in load_repos(paths):
+        try:
+            branch = describe_head(repo.path)
+        except GitError:
+            # Missing or uninitialized sub-repo: report it and keep going so
+            # the rest of the workspace is still listed.
+            all_match = False
+            logger.warning(f"{repo.name}: (missing — run `multi sync`)")
+            continue
+        expected_branch = repo.fixed_branch or root_branch
+        if branch == expected_branch:
+            logger.info(f"{repo.name}: {branch}")
+        else:
+            all_match = False
+            if repo.fixed_branch:
+                expectation = f"fixed branch {expected_branch}"
+            else:
+                expectation = f"root branch {root_branch}"
+            logger.warning(f"{repo.name}: {branch} (expected {expectation})")
+    return all_match
+
+
+@click.command(name="branch")
+def branch_cmd() -> None:
+    """Show the current branch of the root repo and every sub-repo.
+
+    Read-only: unlike `multi set-branch` and `multi git`, this works with
+    dirty working trees, mismatched branches, and detached HEADs.
+    Exits with an error status when repos are not on their expected branches.
+    """
+    paths = Paths(Path.cwd())
+    if not report_branches(paths):
+        raise GitError(
+            "Repositories are missing or not on their expected branches. "
+            "Run `multi sync` to clone missing repos, or `multi set-branch` "
+            "(with clean working trees) to fix branch mismatches."
+        )

{multi_workspace-3.2.8 → multi_workspace-3.2.10}/multi/cli.py

@@ -2,6 +2,7 @@ import click
 
 from multi._version import __version__
 from multi.add import add_cmd
+from multi.branch import branch_cmd
 from multi.cli_helpers import common_command_wrapper
 from multi.collaborator import collaborator_cmd
 from multi.convert_monorepo import convert_monorepo_cmd
@@ -46,6 +47,7 @@ def main():
 
 main.add_command(common_command_wrapper(add_cmd))
 main.add_command(collaborator_cmd)
+main.add_command(common_command_wrapper(branch_cmd))
 main.add_command(common_command_wrapper(set_branch_cmd))
 main.add_command(common_command_wrapper(sync_cmd))
 main.add_command(common_command_wrapper(git_cmd))

{multi_workspace-3.2.8 → multi_workspace-3.2.10}/multi/cli_helpers.py

@@ -11,7 +11,9 @@ from multi.git_helpers import check_all_on_same_branch
 from multi.logging import configure_logging
 from multi.paths import Paths
 
-COMMANDS_WITHOUT_WORKSPACE_BRANCH_CHECK = {"doctor", "recent-users"}
+# `branch` is excluded because it reports branch state itself (including
+# mismatches); re-running the post-command check would duplicate the output.
+COMMANDS_WITHOUT_WORKSPACE_BRANCH_CHECK = {"branch", "doctor", "recent-users"}
 
 
 def get_install_set_from_context() -> str | None:

{multi_workspace-3.2.8 → multi_workspace-3.2.10}/multi/git_helpers.py

@@ -24,31 +24,51 @@ def is_git_repo_root(repo_path: Path) -> bool:
     return Path(repo.working_tree_dir or "").resolve() == repo_path.resolve()
 
 
-def get_current_branch(repo_path: Path) -> str:
-    """Get the current branch name of a git repository."""
+def _open_repo_for_branch_lookup(repo_path: Path) -> git.Repo:
     try:
-        repo = git.Repo(repo_path)
-        return repo.active_branch.name
+        return git.Repo(repo_path)
     except (InvalidGitRepositoryError, NoSuchPathError) as e:
-        msg = (
-            f"Could not determine current branch for {repo_path}: not a git repository. "
-            "Initialize it with `git init -b main` or run `multi sync` from the workspace root."
-        )
-        logger.error(msg)
-        raise GitError(msg) from e
-    except TypeError:
-        # Detached HEAD state - active_branch raises TypeError
+        # No logging here: callers (or the CLI error wrapper) report the
+        # error exactly once.
+        raise GitError(
+            f"Could not determine current branch for {repo_path.name}: not a git "
+            "repository. Run `multi sync` from the workspace root."
+        ) from e
+
+
+def get_current_branch(repo_path: Path) -> str:
+    """Get the current branch name of a git repository."""
+    repo = _open_repo_for_branch_lookup(repo_path)
+    if repo.head.is_detached:
+        # Detached HEAD state has no branch name.
         return "HEAD"
+    return repo.active_branch.name
+
+
+def describe_head(repo_path: Path) -> str:
+    """Return the current branch name, or a detached-HEAD description.
+
+    Read-only: works with dirty working trees and in linked worktrees
+    (where ``.git`` is a file). A detached HEAD is reported as
+    ``(detached at <short-sha>)`` instead of failing.
+    """
+    repo = _open_repo_for_branch_lookup(repo_path)
+    if repo.head.is_detached:
+        return f"(detached at {repo.git.rev_parse('--short', 'HEAD')})"
+    return repo.active_branch.name
 
 
 def check_all_on_same_branch(paths: Paths, raise_error: bool = True) -> bool:
-    """Validate that all repositories are on the expected branch."""
+    """Validate that all repositories are on the expected branch.
+
+    Read-only: does not require clean working trees. Detached HEADs are
+    reported as ``(detached at <short-sha>)`` and never match an expected
+    branch name.
+    """
     from multi.repos import load_repos
 
-    root_branch = get_current_branch(paths.root_dir)
-    repo_branches = [
-        (repo, get_current_branch(repo.path)) for repo in load_repos(paths)
-    ]
+    root_branch = describe_head(paths.root_dir)
+    repo_branches = [(repo, describe_head(repo.path)) for repo in load_repos(paths)]
     for repo, branch in repo_branches:
         expected_branch = repo.fixed_branch or root_branch
         if branch != expected_branch:

{multi_workspace-3.2.8 → multi_workspace-3.2.10}/multi/git_run.py

@@ -46,7 +46,7 @@ def run_git_in_all_repos(paths: Paths, git_args: List[str]) -> None:
         run_git_command(repo.path, git_args)
 
 
-@click.command(name="git")
+@click.command(name="git", context_settings={"ignore_unknown_options": True})
 @click.argument("git_args", nargs=-1, required=True)
 def git_cmd(git_args: tuple[str, ...]) -> None:
     """Run a git command across all repositories.
@@ -55,6 +55,10 @@ def git_cmd(git_args: tuple[str, ...]) -> None:
 
     Example: multi git pull
              multi git checkout -b feature/new-branch
+             multi git branch --show-current
+
+    Requires all repositories to be on the same branch (working trees may be
+    dirty). To inspect branches when they mismatch, use `multi branch`.
     """
     paths = Paths(Path.cwd())
     if paths.settings.is_monorepo():