refactor(version): separate version and release commands
`markitect version` now prints a clean version string (Unix style), with -v for commit/branch/dirty. `markitect release` shows detailed development status: commits since tag, local changes, upstream divergence. No overlap between the two commands. Replaces get_version_info()/get_release_info() with get_version() and get_release_status(). Drops yaml output format from release (json + text sufficient). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
@@ -8,11 +8,40 @@ git tags so it stays correct even without ``pip install -e .``.
|
||||
|
||||
import subprocess
|
||||
from pathlib import Path
|
||||
from typing import Optional
|
||||
|
||||
_PROJECT_ROOT = Path(__file__).parent.parent
|
||||
|
||||
|
||||
def _git_version() -> str | None:
|
||||
# ── Low-level helpers ────────────────────────────────────────────────────
|
||||
|
||||
def _is_git_repo() -> bool:
|
||||
try:
|
||||
subprocess.check_output(
|
||||
["git", "rev-parse", "--git-dir"],
|
||||
cwd=_PROJECT_ROOT,
|
||||
stderr=subprocess.DEVNULL,
|
||||
)
|
||||
return True
|
||||
except (subprocess.CalledProcessError, FileNotFoundError):
|
||||
return False
|
||||
|
||||
|
||||
def _git(*args: str) -> Optional[str]:
|
||||
"""Run a git command and return stripped stdout, or None on failure."""
|
||||
try:
|
||||
return subprocess.check_output(
|
||||
["git", *args],
|
||||
cwd=_PROJECT_ROOT,
|
||||
stderr=subprocess.DEVNULL,
|
||||
).decode().strip() or None
|
||||
except (subprocess.CalledProcessError, FileNotFoundError):
|
||||
return None
|
||||
|
||||
|
||||
# ── Version resolution ───────────────────────────────────────────────────
|
||||
|
||||
def _git_version() -> Optional[str]:
|
||||
"""Derive version from git via setuptools-scm (runtime, no install needed)."""
|
||||
try:
|
||||
from setuptools_scm import get_version
|
||||
@@ -30,18 +59,6 @@ def _static_version() -> str:
|
||||
return "unknown"
|
||||
|
||||
|
||||
def _is_git_repo() -> bool:
|
||||
try:
|
||||
subprocess.check_output(
|
||||
["git", "rev-parse", "--git-dir"],
|
||||
cwd=_PROJECT_ROOT,
|
||||
stderr=subprocess.DEVNULL,
|
||||
)
|
||||
return True
|
||||
except (subprocess.CalledProcessError, FileNotFoundError):
|
||||
return False
|
||||
|
||||
|
||||
def _resolve_version() -> str:
|
||||
"""Pick the best available version string.
|
||||
|
||||
@@ -59,88 +76,86 @@ def _resolve_version() -> str:
|
||||
__version__ = _resolve_version()
|
||||
|
||||
|
||||
def get_version():
|
||||
"""Get the current version string."""
|
||||
return __version__
|
||||
def get_version() -> str:
|
||||
"""Return a clean version string (for ``markitect version``).
|
||||
|
||||
On a tagged commit returns the tag (e.g. ``0.12.0``).
|
||||
Otherwise returns the base version without dev/local suffixes.
|
||||
Matches Unix convention: ``tool --version`` prints a stable string.
|
||||
"""
|
||||
if _is_git_repo():
|
||||
tag = _git("describe", "--tags", "--exact-match", "HEAD")
|
||||
if tag:
|
||||
return tag.lstrip("v")
|
||||
# Strip .devN+local from scm version.
|
||||
return __version__.split(".dev")[0] if ".dev" in __version__ else __version__
|
||||
|
||||
|
||||
def _git_info() -> dict:
|
||||
"""Gather git metadata (commit, branch, tag)."""
|
||||
info: dict = {"is_git_repo": False}
|
||||
if not _is_git_repo():
|
||||
return info
|
||||
info["is_git_repo"] = True
|
||||
# ── Release status (used by ``markitect release``) ──────────────────────
|
||||
|
||||
def _run(*args: str) -> str | None:
|
||||
try:
|
||||
return subprocess.check_output(
|
||||
["git", *args],
|
||||
cwd=_PROJECT_ROOT,
|
||||
stderr=subprocess.DEVNULL,
|
||||
).decode().strip()
|
||||
except (subprocess.CalledProcessError, FileNotFoundError):
|
||||
return None
|
||||
def get_release_status() -> dict:
|
||||
"""Gather detailed release / development status.
|
||||
|
||||
info["git_commit"] = _run("rev-parse", "--short", "HEAD") or "unknown"
|
||||
info["git_branch"] = _run("rev-parse", "--abbrev-ref", "HEAD") or "unknown"
|
||||
info["git_tag"] = _run("describe", "--tags", "--exact-match", "HEAD")
|
||||
return info
|
||||
|
||||
|
||||
def get_version_info():
|
||||
"""Get comprehensive version information."""
|
||||
try:
|
||||
from release_management.utils.version import get_version_info as rm_get_version_info
|
||||
return rm_get_version_info(_PROJECT_ROOT)
|
||||
except (ImportError, Exception):
|
||||
pass
|
||||
|
||||
git = _git_info()
|
||||
is_dev = ".dev" in __version__
|
||||
|
||||
return {
|
||||
Returns a dict with:
|
||||
version, commit, branch, tag, is_dev, is_dirty,
|
||||
commits_since_tag, changed_files, upstream_diff.
|
||||
"""
|
||||
info: dict = {
|
||||
"full_version": __version__,
|
||||
"short_version": __version__.split(".dev")[0] if is_dev else __version__,
|
||||
"is_dev": is_dev,
|
||||
"is_git_repo": git.get("is_git_repo", False),
|
||||
"git_commit": git.get("git_commit", "unknown"),
|
||||
"git_branch": git.get("git_branch", "unknown"),
|
||||
"git_tag": git.get("git_tag"),
|
||||
"is_git_repo": _is_git_repo(),
|
||||
}
|
||||
|
||||
if not info["is_git_repo"]:
|
||||
info.update(
|
||||
version=__version__, commit=None, branch=None, tag=None,
|
||||
is_dev=".dev" in __version__, is_dirty=False,
|
||||
commits_since_tag=0, changed_files=[], upstream_diff=None,
|
||||
)
|
||||
return info
|
||||
|
||||
def _normalize_release_info(raw):
|
||||
"""Ensure release info dict has the keys the CLI release command expects."""
|
||||
if "full_version" in raw:
|
||||
return raw
|
||||
info["commit"] = _git("rev-parse", "--short", "HEAD")
|
||||
info["branch"] = _git("rev-parse", "--abbrev-ref", "HEAD")
|
||||
info["tag"] = _git("describe", "--tags", "--exact-match", "HEAD")
|
||||
|
||||
version = raw.get("version", "unknown")
|
||||
is_dev = raw.get("is_development", ".dev" in version)
|
||||
commit = raw.get("git_commit", "unknown")
|
||||
git = _git_info()
|
||||
# Authoritative version: tag if present, otherwise scm-derived base.
|
||||
if info["tag"]:
|
||||
info["version"] = info["tag"].lstrip("v")
|
||||
else:
|
||||
info["version"] = __version__.split(".dev")[0] if ".dev" in __version__ else __version__
|
||||
info["is_dev"] = info["tag"] is None or ".dev" in __version__
|
||||
|
||||
return {
|
||||
"full_version": version,
|
||||
"release_type": "development" if is_dev else "release",
|
||||
"build_from": "git" if git.get("is_git_repo") else "source",
|
||||
"commit": commit,
|
||||
"clean_build": not is_dev,
|
||||
"is_git_repo": git.get("is_git_repo", False),
|
||||
"git_tag": git.get("git_tag"),
|
||||
}
|
||||
# Dirty working tree?
|
||||
info["is_dirty"] = _git("status", "--porcelain") is not None
|
||||
|
||||
# Commits since last tag.
|
||||
describe = _git("describe", "--tags", "--long")
|
||||
if describe:
|
||||
# format: v0.12.0-3-gabcdef → 3 commits since tag
|
||||
parts = describe.rsplit("-", 2)
|
||||
info["commits_since_tag"] = int(parts[1]) if len(parts) == 3 else 0
|
||||
else:
|
||||
# No tags at all — count all commits.
|
||||
count = _git("rev-list", "--count", "HEAD")
|
||||
info["commits_since_tag"] = int(count) if count else 0
|
||||
|
||||
def get_release_info():
|
||||
"""Get release information."""
|
||||
try:
|
||||
from release_management.utils.version import get_release_info as rm_get_release_info
|
||||
return _normalize_release_info(rm_get_release_info(_PROJECT_ROOT))
|
||||
except (ImportError, Exception):
|
||||
pass
|
||||
# Changed files (staged + unstaged + untracked).
|
||||
status_out = _git("status", "--porcelain")
|
||||
if status_out:
|
||||
info["changed_files"] = status_out.splitlines()
|
||||
else:
|
||||
info["changed_files"] = []
|
||||
|
||||
info = get_version_info()
|
||||
return _normalize_release_info({
|
||||
"version": info["full_version"],
|
||||
"is_development": info["is_dev"],
|
||||
"git_commit": info.get("git_commit", "unknown"),
|
||||
})
|
||||
# Upstream comparison.
|
||||
tracking = _git("rev-parse", "--abbrev-ref", "--symbolic-full-name", "@{u}")
|
||||
if tracking:
|
||||
ahead = _git("rev-list", "--count", f"{tracking}..HEAD")
|
||||
behind = _git("rev-list", "--count", f"HEAD..{tracking}")
|
||||
info["upstream_diff"] = {
|
||||
"tracking": tracking,
|
||||
"ahead": int(ahead) if ahead else 0,
|
||||
"behind": int(behind) if behind else 0,
|
||||
}
|
||||
else:
|
||||
info["upstream_diff"] = None
|
||||
|
||||
return info
|
||||
|
||||
Reference in New Issue
Block a user