From dbe92037653a106ac00c220e5262ceb2fda29d00 Mon Sep 17 00:00:00 2001 From: Pascal Date: Wed, 1 Jul 2026 23:31:06 +0200 Subject: [PATCH 1/2] test: cover namespaced git branch templates Assisted-by: Codex (model: GPT-5, autonomous) --- tests/extensions/git/test_git_extension.py | 141 ++++++++++++++++++++- 1 file changed, 138 insertions(+), 3 deletions(-) diff --git a/tests/extensions/git/test_git_extension.py b/tests/extensions/git/test_git_extension.py index 2f53854d82..d616a85cc6 100644 --- a/tests/extensions/git/test_git_extension.py +++ b/tests/extensions/git/test_git_extension.py @@ -122,10 +122,10 @@ def _run_bash(script_name: str, cwd: Path, *args: str, env_extra: dict | None = ) -def _run_pwsh(script_name: str, cwd: Path, *args: str) -> subprocess.CompletedProcess: +def _run_pwsh(script_name: str, cwd: Path, *args: str, env_extra: dict | None = None) -> subprocess.CompletedProcess: """Run an extension PowerShell script.""" script = cwd / ".specify" / "extensions" / "git" / "scripts" / "powershell" / script_name - env = {**os.environ, **_GIT_ENV} + env = {**os.environ, **_GIT_ENV, **(env_extra or {})} return subprocess.run( ["pwsh", "-NoProfile", "-File", str(script), *args], cwd=cwd, @@ -363,6 +363,69 @@ def test_increments_from_existing_specs(self, tmp_path: Path): data = json.loads(result.stdout) assert data["FEATURE_NUM"] == "003" + def test_branch_template_adds_author_and_app_namespace(self, tmp_path: Path): + """branch_template namespaces generated branch names for monorepos.""" + project = _setup_project(tmp_path / "app-a") + subprocess.run(["git", "config", "user.name", "jdoe"], cwd=project, check=True) + _write_config(project, 'branch_template: "{author}/{app}/{number}-{slug}"\n') + + result = _run_bash( + "create-new-feature-branch.sh", project, + "--json", "--short-name", "guided-tour", "Add guided tour", + ) + + assert result.returncode == 0, result.stderr + data = json.loads(result.stdout) + assert data["BRANCH_NAME"] == "jdoe/app-a/001-guided-tour" + assert data["FEATURE_NUM"] == "001" + + def test_branch_prefix_shorthand_adds_namespace(self, tmp_path: Path): + """branch_prefix expands to a namespace before the default branch shape.""" + project = _setup_project(tmp_path / "app-a") + _write_config(project, 'branch_prefix: "features/{app}"\n') + + result = _run_bash( + "create-new-feature-branch.sh", project, + "--json", "--short-name", "guided-tour", "Add guided tour", + ) + + assert result.returncode == 0, result.stderr + data = json.loads(result.stdout) + assert data["BRANCH_NAME"] == "features/app-a/001-guided-tour" + assert data["FEATURE_NUM"] == "001" + + def test_branch_template_scopes_existing_branch_numbers(self, tmp_path: Path): + """Templated branch numbering ignores branches outside the current namespace.""" + project = _setup_project(tmp_path / "app-a") + subprocess.run(["git", "config", "user.name", "jdoe"], cwd=project, check=True) + _write_config(project, 'branch_template: "{author}/{app}/{number}-{slug}"\n') + subprocess.run(["git", "branch", "jdoe/app-a/007-existing"], cwd=project, check=True) + subprocess.run(["git", "branch", "jdoe/app-b/010-other-app"], cwd=project, check=True) + + result = _run_bash( + "create-new-feature-branch.sh", project, + "--json", "--dry-run", "--short-name", "next", "Next feature", + ) + + assert result.returncode == 0, result.stderr + data = json.loads(result.stdout) + assert data["BRANCH_NAME"] == "jdoe/app-a/008-next" + assert data["FEATURE_NUM"] == "008" + + def test_git_branch_name_override_extracts_number_after_namespace(self, tmp_path: Path): + """GIT_BRANCH_NAME extracts FEATURE_NUM from a namespaced branch.""" + project = _setup_project(tmp_path / "app-a") + result = _run_bash( + "create-new-feature-branch.sh", project, + "--json", "Ignored description", + env_extra={"GIT_BRANCH_NAME": "jdoe/app-a/042-custom-branch"}, + ) + + assert result.returncode == 0, result.stderr + data = json.loads(result.stdout) + assert data["BRANCH_NAME"] == "jdoe/app-a/042-custom-branch" + assert data["FEATURE_NUM"] == "042" + def test_dry_run_counts_branches_checked_out_in_worktrees(self, tmp_path: Path): """Branches checked out in sibling worktrees still reserve their prefix.""" project = _setup_project(tmp_path / "project") @@ -525,6 +588,54 @@ def test_creates_branch_timestamp(self, tmp_path: Path): data = json.loads(result.stdout) assert re.match(r"^\d{8}-\d{6}-feat$", data["BRANCH_NAME"]) + def test_branch_template_adds_author_and_app_namespace(self, tmp_path: Path): + """PowerShell supports branch_template namespaces.""" + project = _setup_project(tmp_path / "app-a") + subprocess.run(["git", "config", "user.name", "jdoe"], cwd=project, check=True) + _write_config(project, 'branch_template: "{author}/{app}/{number}-{slug}"\n') + + result = _run_pwsh( + "create-new-feature-branch.ps1", project, + "-Json", "-ShortName", "guided-tour", "Add guided tour", + ) + + assert result.returncode == 0, result.stderr + data = json.loads(result.stdout) + assert data["BRANCH_NAME"] == "jdoe/app-a/001-guided-tour" + assert data["FEATURE_NUM"] == "001" + + def test_branch_template_scopes_existing_branch_numbers(self, tmp_path: Path): + """PowerShell templated numbering ignores branches outside the namespace.""" + project = _setup_project(tmp_path / "app-a") + subprocess.run(["git", "config", "user.name", "jdoe"], cwd=project, check=True) + _write_config(project, 'branch_template: "{author}/{app}/{number}-{slug}"\n') + subprocess.run(["git", "branch", "jdoe/app-a/007-existing"], cwd=project, check=True) + subprocess.run(["git", "branch", "jdoe/app-b/010-other-app"], cwd=project, check=True) + + result = _run_pwsh( + "create-new-feature-branch.ps1", project, + "-Json", "-DryRun", "-ShortName", "next", "Next feature", + ) + + assert result.returncode == 0, result.stderr + data = json.loads(result.stdout) + assert data["BRANCH_NAME"] == "jdoe/app-a/008-next" + assert data["FEATURE_NUM"] == "008" + + def test_git_branch_name_override_extracts_number_after_namespace(self, tmp_path: Path): + """PowerShell GIT_BRANCH_NAME extracts FEATURE_NUM from a namespaced branch.""" + project = _setup_project(tmp_path / "app-a") + result = _run_pwsh( + "create-new-feature-branch.ps1", project, + "-Json", "Ignored description", + env_extra={"GIT_BRANCH_NAME": "jdoe/app-a/042-custom-branch"}, + ) + + assert result.returncode == 0, result.stderr + data = json.loads(result.stdout) + assert data["BRANCH_NAME"] == "jdoe/app-a/042-custom-branch" + assert data["FEATURE_NUM"] == "042" + def test_no_git_graceful_degradation(self, tmp_path: Path): """create-new-feature-branch.ps1 works without git.""" project = _setup_project(tmp_path, git=False) @@ -1011,13 +1122,22 @@ def test_check_feature_branch_accepts_single_prefix(self, tmp_path: Path): ) assert result.returncode == 0 - def test_check_feature_branch_rejects_nested_prefix(self, tmp_path: Path): + def test_check_feature_branch_accepts_nested_prefix(self, tmp_path: Path): project = _setup_project(tmp_path) script = project / ".specify" / "extensions" / "git" / "scripts" / "bash" / "git-common.sh" result = subprocess.run( ["bash", "-c", f'source "{script}" && check_feature_branch "feat/fix/001-x" "true"'], capture_output=True, text=True, ) + assert result.returncode == 0 + + def test_check_feature_branch_rejects_nested_prefix_without_number(self, tmp_path: Path): + project = _setup_project(tmp_path) + script = project / ".specify" / "extensions" / "git" / "scripts" / "bash" / "git-common.sh" + result = subprocess.run( + ["bash", "-c", f'source "{script}" && check_feature_branch "feat/fix/no-number" "true"'], + capture_output=True, text=True, + ) assert result.returncode != 0 @@ -1037,3 +1157,18 @@ def test_test_feature_branch_accepts_single_prefix(self, tmp_path: Path): text=True, ) assert result.returncode == 0 + + def test_test_feature_branch_accepts_nested_prefix(self, tmp_path: Path): + project = _setup_project(tmp_path) + script = project / ".specify" / "extensions" / "git" / "scripts" / "powershell" / "git-common.ps1" + result = subprocess.run( + [ + "pwsh", + "-NoProfile", + "-Command", + f'. "{script}"; if (Test-FeatureBranch -Branch "jdoe/app-a/001-x" -HasGit $true) {{ exit 0 }} else {{ exit 1 }}', + ], + capture_output=True, + text=True, + ) + assert result.returncode == 0 From f48178dccc831b084f688378e8ef2030f5e2ca9b Mon Sep 17 00:00:00 2001 From: Pascal Date: Wed, 1 Jul 2026 23:32:06 +0200 Subject: [PATCH 2/2] feat: support namespaced git branch templates Assisted-by: Codex (model: GPT-5, autonomous) --- extensions/git/README.md | 11 +- .../git/commands/speckit.git.feature.md | 18 +- .../git/commands/speckit.git.validate.md | 12 +- extensions/git/config-template.yml | 5 + extensions/git/extension.yml | 5 +- extensions/git/git-config.yml | 5 + .../scripts/bash/create-new-feature-branch.sh | 184 ++++++++++++++--- extensions/git/scripts/bash/git-common.sh | 9 +- .../powershell/create-new-feature-branch.ps1 | 192 ++++++++++++++---- .../git/scripts/powershell/git-common.ps1 | 12 +- 10 files changed, 368 insertions(+), 85 deletions(-) diff --git a/extensions/git/README.md b/extensions/git/README.md index e2c53fb769..5404cb37b1 100644 --- a/extensions/git/README.md +++ b/extensions/git/README.md @@ -7,7 +7,7 @@ Git repository initialization, feature branch creation, numbering (sequential/ti This extension provides Git operations as an optional, self-contained module. It manages: - **Repository initialization** with configurable commit messages -- **Feature branch creation** with sequential (`001-feature-name`) or timestamp (`20260319-143022-feature-name`) numbering +- **Feature branch creation** with sequential (`001-feature-name`) or timestamp (`20260319-143022-feature-name`) numbering and optional templates for branch namespaces - **Branch validation** to ensure branches follow naming conventions - **Git remote detection** for GitHub integration (e.g., issue creation) - **Auto-commit** after core commands (configurable per-command with custom messages) @@ -53,6 +53,11 @@ Configuration is stored in `.specify/extensions/git/git-config.yml`: # Branch numbering strategy: "sequential" or "timestamp" branch_numbering: sequential +# Optional branch name template. Leave empty for the default "{number}-{slug}". +# Supported tokens: {author}, {app}, {number}, {slug} +# Example for monorepos: "{author}/{app}/{number}-{slug}" +branch_template: "" + # Custom commit message for git init init_commit_message: "[Spec Kit] Initial commit" @@ -65,6 +70,10 @@ auto_commit: message: "[Spec Kit] Add specification" ``` +`{author}` is derived from Git config and sanitized for branch names. `{app}` is derived from the Spec Kit init directory name. For a monorepo project at `apps/web/.specify/`, a template such as `{author}/{app}/{number}-{slug}` produces branches like `jdoe/web/008-guided-tour`. + +For simple namespace-only customization, `branch_prefix` is also accepted as a shorthand and expands to `/{number}-{slug}`. + ## Installation ```bash diff --git a/extensions/git/commands/speckit.git.feature.md b/extensions/git/commands/speckit.git.feature.md index 27fdbd5f72..a19971c471 100644 --- a/extensions/git/commands/speckit.git.feature.md +++ b/extensions/git/commands/speckit.git.feature.md @@ -19,7 +19,7 @@ You **MUST** consider the user input before proceeding (if not empty). If the user explicitly provided `GIT_BRANCH_NAME` (e.g., via environment variable, argument, or in their request), pass it through to the script by setting the `GIT_BRANCH_NAME` environment variable before invoking the script. When `GIT_BRANCH_NAME` is set: - The script uses the exact value as the branch name, bypassing all prefix/suffix generation - `--short-name`, `--number`, and `--timestamp` flags are ignored -- `FEATURE_NUM` is extracted from the name if it starts with a numeric prefix, otherwise set to the full branch name +- `FEATURE_NUM` is extracted from the first numeric or timestamp segment (for example `042-name`, `feat/042-name`, or `jdoe/app/042-name`), otherwise set to the full branch name ## Prerequisites @@ -35,6 +35,19 @@ Determine the branch numbering strategy by checking configuration in this order: 3. Check `.specify/init-options.json` for `branch_numbering` value (deprecated, backward compatibility — will be removed in a future release) 4. Default to `sequential` if none of the above exist +## Branch Name Template + +Check `.specify/extensions/git/git-config.yml` for an optional `branch_template` value. If it is empty or missing, use the default branch shape `{number}-{slug}`. If it is set, the script expands these tokens: + +- `{author}`: sanitized Git config author (`user.name`, falling back to the email local part) +- `{app}`: sanitized Spec Kit init directory name +- `{number}`: sequential number or timestamp +- `{slug}`: generated short branch slug + +For monorepos, a template such as `{author}/{app}/{number}-{slug}` creates names like `jdoe/web/008-guided-tour` while preserving per-project feature numbering. + +The script also accepts `branch_prefix` as a shorthand for simple namespaces; it expands to `/{number}-{slug}`. + ## Execution Generate a concise short name (2-4 words) for the branch: @@ -54,6 +67,7 @@ Run the appropriate script based on your platform: - Always include the JSON flag (`--json` for Bash, `-Json` for PowerShell) so the output can be parsed reliably - You must only ever run this script once per feature - The JSON output will contain `BRANCH_NAME` and `FEATURE_NUM` +- Do not manually expand `branch_template`; the script reads the git extension config and applies it consistently ## Graceful Degradation @@ -64,5 +78,5 @@ If Git is not installed or the current directory is not a Git repository: ## Output The script outputs JSON with: -- `BRANCH_NAME`: The branch name (e.g., `003-user-auth` or `20260319-143022-user-auth`) +- `BRANCH_NAME`: The branch name (e.g., `003-user-auth`, `20260319-143022-user-auth`, or `jdoe/web/003-user-auth`) - `FEATURE_NUM`: The numeric or timestamp prefix used diff --git a/extensions/git/commands/speckit.git.validate.md b/extensions/git/commands/speckit.git.validate.md index dd84618cb8..83f26061fa 100644 --- a/extensions/git/commands/speckit.git.validate.md +++ b/extensions/git/commands/speckit.git.validate.md @@ -22,24 +22,24 @@ Get the current branch name: git rev-parse --abbrev-ref HEAD ``` -The branch name must match one of these patterns: +The branch name must contain one of these feature markers either at the start or after one or more namespace path segments: -1. **Sequential**: `^[0-9]{3,}-` (e.g., `001-feature-name`, `042-fix-bug`, `1000-big-feature`) -2. **Timestamp**: `^[0-9]{8}-[0-9]{6}-` (e.g., `20260319-143022-feature-name`) +1. **Sequential**: `(^|/)[0-9]{3,}-` (e.g., `001-feature-name`, `042-fix-bug`, `1000-big-feature`, `jdoe/web/008-guided-tour`) +2. **Timestamp**: `(^|/)[0-9]{8}-[0-9]{6}-` (e.g., `20260319-143022-feature-name`, `jdoe/web/20260319-143022-feature-name`) ## Execution If on a feature branch (matches either pattern): - Output: `✓ On feature branch: ` - Check if the corresponding spec directory exists under `specs/`: - - For sequential branches, look for `specs/-*` where prefix matches the numeric portion - - For timestamp branches, look for `specs/-*` where prefix matches the `YYYYMMDD-HHMMSS` portion + - For sequential branches, look for `specs/-*` where prefix matches the numeric portion, regardless of branch namespace prefixes + - For timestamp branches, look for `specs/-*` where prefix matches the `YYYYMMDD-HHMMSS` portion, regardless of branch namespace prefixes - If spec directory exists: `✓ Spec directory found: ` - If spec directory missing: `⚠ No spec directory found for prefix ` If NOT on a feature branch: - Output: `✗ Not on a feature branch. Current branch: ` -- Output: `Feature branches should be named like: 001-feature-name or 20260319-143022-feature-name` +- Output: `Feature branches should be named like: 001-feature-name, 20260319-143022-feature-name, or /001-feature-name` ## Graceful Degradation diff --git a/extensions/git/config-template.yml b/extensions/git/config-template.yml index 8c414babe6..05b9f3e9e3 100644 --- a/extensions/git/config-template.yml +++ b/extensions/git/config-template.yml @@ -4,6 +4,11 @@ # Branch numbering strategy: "sequential" (001, 002, ...) or "timestamp" (YYYYMMDD-HHMMSS) branch_numbering: sequential +# Optional branch name template. Leave empty for the default "{number}-{slug}". +# Supported tokens: {author}, {app}, {number}, {slug} +# Example for monorepos: "{author}/{app}/{number}-{slug}" +branch_template: "" + # Commit message used by `git commit` during repository initialization init_commit_message: "[Spec Kit] Initial commit" diff --git a/extensions/git/extension.yml b/extensions/git/extension.yml index 13c1977ea1..fc29387242 100644 --- a/extensions/git/extension.yml +++ b/extensions/git/extension.yml @@ -4,7 +4,7 @@ extension: id: git name: "Git Branching Workflow" version: "1.0.0" - description: "Feature branch creation, numbering (sequential/timestamp), validation, and Git remote detection" + description: "Feature branch creation, numbering (sequential/timestamp), templating, validation, and Git remote detection" author: spec-kit-core repository: https://github.com/github/spec-kit license: MIT @@ -19,7 +19,7 @@ provides: commands: - name: speckit.git.feature file: commands/speckit.git.feature.md - description: "Create a feature branch with sequential or timestamp numbering" + description: "Create a feature branch with sequential or timestamp numbering and optional templates" - name: speckit.git.validate file: commands/speckit.git.validate.md description: "Validate current branch follows feature branch naming conventions" @@ -137,4 +137,5 @@ tags: config: defaults: branch_numbering: sequential + branch_template: "" init_commit_message: "[Spec Kit] Initial commit" diff --git a/extensions/git/git-config.yml b/extensions/git/git-config.yml index 8c414babe6..05b9f3e9e3 100644 --- a/extensions/git/git-config.yml +++ b/extensions/git/git-config.yml @@ -4,6 +4,11 @@ # Branch numbering strategy: "sequential" (001, 002, ...) or "timestamp" (YYYYMMDD-HHMMSS) branch_numbering: sequential +# Optional branch name template. Leave empty for the default "{number}-{slug}". +# Supported tokens: {author}, {app}, {number}, {slug} +# Example for monorepos: "{author}/{app}/{number}-{slug}" +branch_template: "" + # Commit message used by `git commit` during repository initialization init_commit_message: "[Spec Kit] Initial commit" diff --git a/extensions/git/scripts/bash/create-new-feature-branch.sh b/extensions/git/scripts/bash/create-new-feature-branch.sh index c6e4e0668f..fd08489256 100755 --- a/extensions/git/scripts/bash/create-new-feature-branch.sh +++ b/extensions/git/scripts/bash/create-new-feature-branch.sh @@ -75,6 +75,9 @@ while [ $i -le $# ]; do echo "Environment variables:" echo " GIT_BRANCH_NAME Use this exact branch name, bypassing all prefix/suffix generation" echo "" + echo "Configuration:" + echo " branch_template Optional git-config.yml template with {author}, {app}, {number}, {slug}" + echo "" echo "Examples:" echo " $0 'Add user authentication system' --short-name 'user-auth'" echo " $0 'Implement OAuth2 integration for API' --number 5" @@ -127,16 +130,24 @@ get_highest_from_specs() { # Function to get highest number from git branches get_highest_from_branches() { - git branch -a 2>/dev/null | sed -E 's/^[+*][[:space:]]+//; s/^[[:space:]]+//; s|^remotes/[^/]*/||' | _extract_highest_number + local scope_prefix="${1:-}" + git branch -a 2>/dev/null | sed -E 's/^[+*][[:space:]]+//; s/^[[:space:]]+//; s|^remotes/[^/]*/||' | _extract_highest_number "$scope_prefix" } # Extract the highest sequential feature number from a list of ref names (one per line). _extract_highest_number() { + local scope_prefix="${1:-}" local highest=0 while IFS= read -r name; do [ -z "$name" ] && continue - if echo "$name" | grep -Eq '^[0-9]{3,}-' && ! echo "$name" | grep -Eq '^[0-9]{8}-[0-9]{6}-'; then - number=$(echo "$name" | grep -Eo '^[0-9]+' || echo "0") + if [ -n "$scope_prefix" ]; then + case "$name" in + "$scope_prefix"*) ;; + *) continue ;; + esac + fi + if echo "$name" | grep -Eq '(^|/)[0-9]{3,}-' && ! echo "$name" | grep -Eq '(^|/)[0-9]{8}-[0-9]{6}-'; then + number=$(echo "$name" | grep -Eo '(^|/)[0-9]{3,}-' | head -n 1 | sed -E 's|^/||; s/-$//' || echo "0") number=$((10#$number)) if [ "$number" -gt "$highest" ]; then highest=$number @@ -148,11 +159,12 @@ _extract_highest_number() { # Function to get highest number from remote branches without fetching (side-effect-free) get_highest_from_remote_refs() { + local scope_prefix="${1:-}" local highest=0 for remote in $(git remote 2>/dev/null); do local remote_highest - remote_highest=$(GIT_TERMINAL_PROMPT=0 git ls-remote --heads "$remote" 2>/dev/null | sed 's|.*refs/heads/||' | _extract_highest_number) + remote_highest=$(GIT_TERMINAL_PROMPT=0 git ls-remote --heads "$remote" 2>/dev/null | sed 's|.*refs/heads/||' | _extract_highest_number "$scope_prefix") if [ "$remote_highest" -gt "$highest" ]; then highest=$remote_highest fi @@ -165,16 +177,17 @@ get_highest_from_remote_refs() { check_existing_branches() { local specs_dir="$1" local skip_fetch="${2:-false}" + local scope_prefix="${3:-}" if [ "$skip_fetch" = true ]; then - local highest_remote=$(get_highest_from_remote_refs) - local highest_branch=$(get_highest_from_branches) + local highest_remote=$(get_highest_from_remote_refs "$scope_prefix") + local highest_branch=$(get_highest_from_branches "$scope_prefix") if [ "$highest_remote" -gt "$highest_branch" ]; then highest_branch=$highest_remote fi else git fetch --all --prune >/dev/null 2>&1 || true - local highest_branch=$(get_highest_from_branches) + local highest_branch=$(get_highest_from_branches "$scope_prefix") fi local highest_spec=$(get_highest_from_specs "$specs_dir") @@ -273,6 +286,123 @@ fi cd "$REPO_ROOT" SPECS_DIR="$REPO_ROOT/specs" +CONFIG_FILE="$REPO_ROOT/.specify/extensions/git/git-config.yml" + +read_git_config_value() { + local key="$1" + [ -f "$CONFIG_FILE" ] || return 0 + grep -E "^[[:space:]]*${key}:" "$CONFIG_FILE" 2>/dev/null \ + | head -n 1 \ + | sed -E "s/^[[:space:]]*${key}:[[:space:]]*//" \ + | sed -E 's/[[:space:]]+#.*$//' \ + | sed -E 's/^[[:space:]]+|[[:space:]]+$//g' \ + | sed -E 's/^"//; s/"$//' \ + | sed -E "s/^'//; s/'$//" +} + +branch_token() { + local value="$1" + local fallback="$2" + local cleaned + cleaned=$(clean_branch_name "$value") + if [ -n "$cleaned" ]; then + printf '%s\n' "$cleaned" + else + printf '%s\n' "$fallback" + fi +} + +get_author_token() { + local author="" + if command -v git >/dev/null 2>&1; then + author=$(git config user.name 2>/dev/null || true) + if [ -z "$author" ]; then + author=$(git config user.email 2>/dev/null | sed 's/@.*$//' || true) + fi + fi + if [ -z "$author" ]; then + author="${USER:-unknown}" + fi + branch_token "$author" "unknown" +} + +get_app_token() { + branch_token "$(basename "$REPO_ROOT")" "app" +} + +resolve_branch_template() { + local template + local prefix + template=$(read_git_config_value "branch_template") + if [ -n "$template" ]; then + printf '%s\n' "$template" + return + fi + + prefix=$(read_git_config_value "branch_prefix") + if [ -z "$prefix" ]; then + printf '%s\n' "" + return + fi + case "$prefix" in + */) printf '%s%s\n' "$prefix" "{number}-{slug}" ;; + *) printf '%s/%s\n' "$prefix" "{number}-{slug}" ;; + esac +} + +render_branch_template() { + local template="$1" + local feature_num="$2" + local branch_suffix="$3" + local rendered="$template" + rendered=${rendered//\{author\}/$AUTHOR_TOKEN} + rendered=${rendered//\{app\}/$APP_TOKEN} + rendered=${rendered//\{number\}/$feature_num} + rendered=${rendered//\{slug\}/$branch_suffix} + printf '%s\n' "$rendered" +} + +build_branch_name() { + local feature_num="$1" + local branch_suffix="$2" + if [ -n "$BRANCH_TEMPLATE" ]; then + render_branch_template "$BRANCH_TEMPLATE" "$feature_num" "$branch_suffix" + else + printf '%s-%s\n' "$feature_num" "$branch_suffix" + fi +} + +branch_scope_prefix() { + local template="$1" + local prefix="$template" + [ -n "$prefix" ] || return 0 + case "$prefix" in + *"{number}"*) prefix="${prefix%%\{number\}*}" ;; + *"{slug}"*) prefix="${prefix%%\{slug\}*}" ;; + *) return 0 ;; + esac + render_branch_template "$prefix" "" "$BRANCH_SUFFIX" +} + +extract_feature_num_from_branch() { + local branch_name="$1" + local match + match=$(printf '%s\n' "$branch_name" | grep -Eo '(^|/)[0-9]{8}-[0-9]{6}-' | head -n 1 || true) + if [ -n "$match" ]; then + printf '%s\n' "$match" | sed -E 's|^/||; s/-$//' + return + fi + match=$(printf '%s\n' "$branch_name" | grep -Eo '(^|/)[0-9]+-' | head -n 1 || true) + if [ -n "$match" ]; then + printf '%s\n' "$match" | sed -E 's|^/||; s/-$//' + return + fi + printf '%s\n' "$branch_name" +} + +AUTHOR_TOKEN=$(get_author_token) +APP_TOKEN=$(get_app_token) +BRANCH_TEMPLATE=$(resolve_branch_template) # Function to generate branch name with stop word filtering generate_branch_name() { @@ -318,18 +448,8 @@ generate_branch_name() { # Check for GIT_BRANCH_NAME env var override (exact branch name, no prefix/suffix) if [ -n "${GIT_BRANCH_NAME:-}" ]; then BRANCH_NAME="$GIT_BRANCH_NAME" - # Extract FEATURE_NUM from the branch name if it starts with a numeric prefix - # Check timestamp pattern first (YYYYMMDD-HHMMSS-) since it also matches the simpler ^[0-9]+ pattern - if echo "$BRANCH_NAME" | grep -Eq '^[0-9]{8}-[0-9]{6}-'; then - FEATURE_NUM=$(echo "$BRANCH_NAME" | grep -Eo '^[0-9]{8}-[0-9]{6}') - BRANCH_SUFFIX="${BRANCH_NAME#${FEATURE_NUM}-}" - elif echo "$BRANCH_NAME" | grep -Eq '^[0-9]+-'; then - FEATURE_NUM=$(echo "$BRANCH_NAME" | grep -Eo '^[0-9]+') - BRANCH_SUFFIX="${BRANCH_NAME#${FEATURE_NUM}-}" - else - FEATURE_NUM="$BRANCH_NAME" - BRANCH_SUFFIX="$BRANCH_NAME" - fi + FEATURE_NUM=$(extract_feature_num_from_branch "$BRANCH_NAME") + BRANCH_SUFFIX="$BRANCH_NAME" else # Generate branch name if [ -n "$SHORT_NAME" ]; then @@ -347,16 +467,17 @@ else # Determine branch prefix if [ "$USE_TIMESTAMP" = true ]; then FEATURE_NUM=$(date +%Y%m%d-%H%M%S) - BRANCH_NAME="${FEATURE_NUM}-${BRANCH_SUFFIX}" + BRANCH_NAME=$(build_branch_name "$FEATURE_NUM" "$BRANCH_SUFFIX") else + BRANCH_SCOPE_PREFIX=$(branch_scope_prefix "$BRANCH_TEMPLATE") if [ -z "$BRANCH_NUMBER" ]; then if [ "$DRY_RUN" = true ] && [ "$HAS_GIT" = true ]; then - BRANCH_NUMBER=$(check_existing_branches "$SPECS_DIR" true) + BRANCH_NUMBER=$(check_existing_branches "$SPECS_DIR" true "$BRANCH_SCOPE_PREFIX") elif [ "$DRY_RUN" = true ]; then HIGHEST=$(get_highest_from_specs "$SPECS_DIR") BRANCH_NUMBER=$((HIGHEST + 1)) elif [ "$HAS_GIT" = true ]; then - BRANCH_NUMBER=$(check_existing_branches "$SPECS_DIR") + BRANCH_NUMBER=$(check_existing_branches "$SPECS_DIR" false "$BRANCH_SCOPE_PREFIX") else HIGHEST=$(get_highest_from_specs "$SPECS_DIR") BRANCH_NUMBER=$((HIGHEST + 1)) @@ -364,7 +485,7 @@ else fi FEATURE_NUM=$(printf "%03d" "$((10#$BRANCH_NUMBER))") - BRANCH_NAME="${FEATURE_NUM}-${BRANCH_SUFFIX}" + BRANCH_NAME=$(build_branch_name "$FEATURE_NUM" "$BRANCH_SUFFIX") fi fi @@ -376,14 +497,17 @@ if [ -n "${GIT_BRANCH_NAME:-}" ] && [ "$BRANCH_BYTE_LEN" -gt $MAX_BRANCH_LENGTH >&2 echo "Error: GIT_BRANCH_NAME must be 244 bytes or fewer in UTF-8. Provided value is ${BRANCH_BYTE_LEN} bytes." exit 1 elif [ "$BRANCH_BYTE_LEN" -gt $MAX_BRANCH_LENGTH ]; then - PREFIX_LENGTH=$(( ${#FEATURE_NUM} + 1 )) - MAX_SUFFIX_LENGTH=$((MAX_BRANCH_LENGTH - PREFIX_LENGTH)) - - TRUNCATED_SUFFIX=$(echo "$BRANCH_SUFFIX" | cut -c1-$MAX_SUFFIX_LENGTH) - TRUNCATED_SUFFIX=$(echo "$TRUNCATED_SUFFIX" | sed 's/-$//') - ORIGINAL_BRANCH_NAME="$BRANCH_NAME" - BRANCH_NAME="${FEATURE_NUM}-${TRUNCATED_SUFFIX}" + TRUNCATED_SUFFIX="$BRANCH_SUFFIX" + while [ "$(_byte_length "$BRANCH_NAME")" -gt "$MAX_BRANCH_LENGTH" ] && [ -n "$TRUNCATED_SUFFIX" ]; do + TRUNCATED_SUFFIX="${TRUNCATED_SUFFIX%?}" + TRUNCATED_SUFFIX="${TRUNCATED_SUFFIX%-}" + BRANCH_NAME=$(build_branch_name "$FEATURE_NUM" "$TRUNCATED_SUFFIX") + done + if [ "$(_byte_length "$BRANCH_NAME")" -gt "$MAX_BRANCH_LENGTH" ]; then + >&2 echo "Error: Branch template prefix exceeds GitHub's 244-byte branch name limit." + exit 1 + fi >&2 echo "[specify] Warning: Branch name exceeded GitHub's 244-byte limit" >&2 echo "[specify] Original: $ORIGINAL_BRANCH_NAME (${#ORIGINAL_BRANCH_NAME} bytes)" diff --git a/extensions/git/scripts/bash/git-common.sh b/extensions/git/scripts/bash/git-common.sh index b78356d1c6..0d55e890e2 100755 --- a/extensions/git/scripts/bash/git-common.sh +++ b/extensions/git/scripts/bash/git-common.sh @@ -23,7 +23,8 @@ spec_kit_effective_branch_name() { } # Validate that a branch name matches the expected feature branch pattern. -# Accepts sequential (###-* with >=3 digits) or timestamp (YYYYMMDD-HHMMSS-*) formats. +# Accepts sequential (###-* with >=3 digits) or timestamp (YYYYMMDD-HHMMSS-*) formats, +# either at the start of the branch or after path-style namespace prefixes. # Logic aligned with scripts/bash/common.sh check_feature_branch after effective-name normalization. check_feature_branch() { local raw="$1" @@ -41,12 +42,12 @@ check_feature_branch() { # Accept sequential prefix (3+ digits) but exclude malformed timestamps # Malformed: 7-or-8 digit date + 6-digit time with no trailing slug (e.g. "2026031-143022" or "20260319-143022") local is_sequential=false - if [[ "$branch" =~ ^[0-9]{3,}- ]] && [[ ! "$branch" =~ ^[0-9]{7}-[0-9]{6}- ]] && [[ ! "$branch" =~ ^[0-9]{7,8}-[0-9]{6}$ ]]; then + if [[ "$branch" =~ (^|/)[0-9]{3,}- ]] && [[ ! "$branch" =~ (^|/)[0-9]{7}-[0-9]{6}- ]] && [[ ! "$branch" =~ (^|/)[0-9]{7,8}-[0-9]{6}$ ]]; then is_sequential=true fi - if [[ "$is_sequential" != "true" ]] && [[ ! "$branch" =~ ^[0-9]{8}-[0-9]{6}- ]]; then + if [[ "$is_sequential" != "true" ]] && [[ ! "$branch" =~ (^|/)[0-9]{8}-[0-9]{6}- ]]; then echo "ERROR: Not on a feature branch. Current branch: $raw" >&2 - echo "Feature branches should be named like: 001-feature-name, 1234-feature-name, or 20260319-143022-feature-name" >&2 + echo "Feature branches should be named like: 001-feature-name, 1234-feature-name, 20260319-143022-feature-name, or /001-feature-name" >&2 return 1 fi diff --git a/extensions/git/scripts/powershell/create-new-feature-branch.ps1 b/extensions/git/scripts/powershell/create-new-feature-branch.ps1 index 0439ec80ad..a93c96e477 100644 --- a/extensions/git/scripts/powershell/create-new-feature-branch.ps1 +++ b/extensions/git/scripts/powershell/create-new-feature-branch.ps1 @@ -34,6 +34,9 @@ if ($Help) { Write-Host "Environment variables:" Write-Host " GIT_BRANCH_NAME Use this exact branch name, bypassing all prefix/suffix generation" Write-Host "" + Write-Host "Configuration:" + Write-Host " branch_template Optional git-config.yml template with {author}, {app}, {number}, {slug}" + Write-Host "" exit 0 } @@ -67,13 +70,19 @@ function Get-HighestNumberFromSpecs { } function Get-HighestNumberFromNames { - param([string[]]$Names) + param( + [string[]]$Names, + [string]$ScopePrefix = '' + ) [long]$highest = 0 foreach ($name in $Names) { - if ($name -match '^(\d{3,})-' -and $name -notmatch '^\d{8}-\d{6}-') { + if ($ScopePrefix -and -not $name.StartsWith($ScopePrefix, [System.StringComparison]::Ordinal)) { + continue + } + if ($name -match '(^|/)(\d{3,})-' -and $name -notmatch '(^|/)\d{8}-\d{6}-') { [long]$num = 0 - if ([long]::TryParse($matches[1], [ref]$num) -and $num -gt $highest) { + if ([long]::TryParse($matches[2], [ref]$num) -and $num -gt $highest) { $highest = $num } } @@ -82,7 +91,7 @@ function Get-HighestNumberFromNames { } function Get-HighestNumberFromBranches { - param() + param([string]$ScopePrefix = '') try { $branches = git branch -a 2>$null @@ -90,7 +99,7 @@ function Get-HighestNumberFromBranches { $cleanNames = $branches | ForEach-Object { $_.Trim() -replace '^[+*]?\s+', '' -replace '^remotes/[^/]+/', '' } - return Get-HighestNumberFromNames -Names $cleanNames + return Get-HighestNumberFromNames -Names $cleanNames -ScopePrefix $ScopePrefix } } catch { Write-Verbose "Could not check Git branches: $_" @@ -99,6 +108,8 @@ function Get-HighestNumberFromBranches { } function Get-HighestNumberFromRemoteRefs { + param([string]$ScopePrefix = '') + [long]$highest = 0 try { $remotes = git remote 2>$null @@ -111,7 +122,7 @@ function Get-HighestNumberFromRemoteRefs { $refNames = $refs | ForEach-Object { if ($_ -match 'refs/heads/(.+)$') { $matches[1] } } | Where-Object { $_ } - $remoteHighest = Get-HighestNumberFromNames -Names $refNames + $remoteHighest = Get-HighestNumberFromNames -Names $refNames -ScopePrefix $ScopePrefix if ($remoteHighest -gt $highest) { $highest = $remoteHighest } } } @@ -125,18 +136,19 @@ function Get-HighestNumberFromRemoteRefs { function Get-NextBranchNumber { param( [string]$SpecsDir, - [switch]$SkipFetch + [switch]$SkipFetch, + [string]$ScopePrefix = '' ) if ($SkipFetch) { - $highestBranch = Get-HighestNumberFromBranches - $highestRemote = Get-HighestNumberFromRemoteRefs + $highestBranch = Get-HighestNumberFromBranches -ScopePrefix $ScopePrefix + $highestRemote = Get-HighestNumberFromRemoteRefs -ScopePrefix $ScopePrefix $highestBranch = [Math]::Max($highestBranch, $highestRemote) } else { try { git fetch --all --prune 2>$null | Out-Null } catch { } - $highestBranch = Get-HighestNumberFromBranches + $highestBranch = Get-HighestNumberFromBranches -ScopePrefix $ScopePrefix } $highestSpec = Get-HighestNumberFromSpecs -SpecsDir $SpecsDir @@ -232,6 +244,124 @@ if (Get-Command Test-HasGit -ErrorAction SilentlyContinue) { Set-Location $repoRoot $specsDir = Join-Path $repoRoot 'specs' +$configFile = Join-Path $repoRoot ".specify/extensions/git/git-config.yml" + +function Read-GitConfigValue { + param([string]$Key) + + if (-not (Test-Path -LiteralPath $configFile -PathType Leaf)) { return '' } + $escapedKey = [regex]::Escape($Key) + foreach ($line in Get-Content -LiteralPath $configFile) { + if ($line -match "^\s*$escapedKey\s*:\s*(.*)$") { + $val = ($matches[1] -replace '\s+#.*$', '').Trim() + $val = $val -replace '^["'']', '' -replace '["'']$', '' + return $val + } + } + return '' +} + +function ConvertTo-BranchToken { + param( + [string]$Value, + [string]$Fallback + ) + + $cleaned = ConvertTo-CleanBranchName -Name $Value + if ($cleaned) { return $cleaned } + return $Fallback +} + +function Get-GitAuthorToken { + $author = '' + if (Get-Command git -ErrorAction SilentlyContinue) { + try { $author = (git config user.name 2>$null | Out-String).Trim() } catch {} + if (-not $author) { + try { + $email = (git config user.email 2>$null | Out-String).Trim() + if ($email) { $author = ($email -split '@')[0] } + } catch {} + } + } + if (-not $author) { $author = if ($env:USER) { $env:USER } elseif ($env:USERNAME) { $env:USERNAME } else { 'unknown' } } + return ConvertTo-BranchToken -Value $author -Fallback 'unknown' +} + +function Get-AppToken { + return ConvertTo-BranchToken -Value (Split-Path $repoRoot -Leaf) -Fallback 'app' +} + +function Resolve-BranchTemplate { + $template = Read-GitConfigValue -Key 'branch_template' + if ($template) { return $template } + + $prefix = Read-GitConfigValue -Key 'branch_prefix' + if (-not $prefix) { return '' } + if ($prefix.EndsWith('/')) { return "${prefix}{number}-{slug}" } + return "$prefix/{number}-{slug}" +} + +function Expand-BranchTemplate { + param( + [string]$Template, + [string]$FeatureNum, + [string]$BranchSuffix + ) + + $rendered = $Template.Replace('{author}', $authorToken) + $rendered = $rendered.Replace('{app}', $appToken) + $rendered = $rendered.Replace('{number}', $FeatureNum) + $rendered = $rendered.Replace('{slug}', $BranchSuffix) + return $rendered +} + +function New-BranchName { + param( + [string]$FeatureNum, + [string]$BranchSuffix + ) + + if ($branchTemplate) { + return Expand-BranchTemplate -Template $branchTemplate -FeatureNum $FeatureNum -BranchSuffix $BranchSuffix + } + return "$FeatureNum-$BranchSuffix" +} + +function Get-BranchScopePrefix { + param( + [string]$Template, + [string]$BranchSuffix + ) + + if (-not $Template) { return '' } + $numberIndex = $Template.IndexOf('{number}', [System.StringComparison]::Ordinal) + $slugIndex = $Template.IndexOf('{slug}', [System.StringComparison]::Ordinal) + $indexes = @($numberIndex, $slugIndex) | Where-Object { $_ -ge 0 } | Sort-Object + if (-not $indexes) { return '' } + $prefix = $Template.Substring(0, $indexes[0]) + return Expand-BranchTemplate -Template $prefix -FeatureNum '' -BranchSuffix $BranchSuffix +} + +function Get-FeatureNumberFromBranchName { + param([string]$BranchName) + + if ($BranchName -match '(?:^|/)(\d{8}-\d{6})-') { + return $matches[1] + } + if ($BranchName -match '(?:^|/)(\d+)-') { + return $matches[1] + } + return $BranchName +} + +function Get-Utf8ByteCount { + param([string]$Value) + return [System.Text.Encoding]::UTF8.GetByteCount($Value) +} + +$authorToken = Get-GitAuthorToken +$appToken = Get-AppToken +$branchTemplate = Resolve-BranchTemplate function Get-BranchName { param([string]$Description) @@ -276,19 +406,11 @@ function Get-BranchName { if ($env:GIT_BRANCH_NAME) { $branchName = $env:GIT_BRANCH_NAME # Check 244-byte limit (UTF-8) for override names - $branchNameUtf8ByteCount = [System.Text.Encoding]::UTF8.GetByteCount($branchName) + $branchNameUtf8ByteCount = Get-Utf8ByteCount -Value $branchName if ($branchNameUtf8ByteCount -gt 244) { throw "GIT_BRANCH_NAME must be 244 bytes or fewer in UTF-8. Provided value is $branchNameUtf8ByteCount bytes; please supply a shorter override branch name." } - # Extract FEATURE_NUM from the branch name if it starts with a numeric prefix - # Check timestamp pattern first (YYYYMMDD-HHMMSS-) since it also matches the simpler ^\d+ pattern - if ($branchName -match '^(\d{8}-\d{6})-') { - $featureNum = $matches[1] - } elseif ($branchName -match '^(\d+)-') { - $featureNum = $matches[1] - } else { - $featureNum = $branchName - } + $featureNum = Get-FeatureNumberFromBranchName -BranchName $branchName } else { if ($ShortName) { $branchSuffix = ConvertTo-CleanBranchName -Name $ShortName @@ -303,39 +425,41 @@ if ($env:GIT_BRANCH_NAME) { if ($Timestamp) { $featureNum = Get-Date -Format 'yyyyMMdd-HHmmss' - $branchName = "$featureNum-$branchSuffix" + $branchName = New-BranchName -FeatureNum $featureNum -BranchSuffix $branchSuffix } else { + $branchScopePrefix = Get-BranchScopePrefix -Template $branchTemplate -BranchSuffix $branchSuffix if ($Number -eq 0) { if ($DryRun -and $hasGit) { - $Number = Get-NextBranchNumber -SpecsDir $specsDir -SkipFetch + $Number = Get-NextBranchNumber -SpecsDir $specsDir -SkipFetch -ScopePrefix $branchScopePrefix } elseif ($DryRun) { $Number = (Get-HighestNumberFromSpecs -SpecsDir $specsDir) + 1 } elseif ($hasGit) { - $Number = Get-NextBranchNumber -SpecsDir $specsDir + $Number = Get-NextBranchNumber -SpecsDir $specsDir -ScopePrefix $branchScopePrefix } else { $Number = (Get-HighestNumberFromSpecs -SpecsDir $specsDir) + 1 } } $featureNum = ('{0:000}' -f $Number) - $branchName = "$featureNum-$branchSuffix" + $branchName = New-BranchName -FeatureNum $featureNum -BranchSuffix $branchSuffix } } $maxBranchLength = 244 -if ($branchName.Length -gt $maxBranchLength) { - $prefixLength = $featureNum.Length + 1 - $maxSuffixLength = $maxBranchLength - $prefixLength - - $truncatedSuffix = $branchSuffix.Substring(0, [Math]::Min($branchSuffix.Length, $maxSuffixLength)) - $truncatedSuffix = $truncatedSuffix -replace '-$', '' - +if ((Get-Utf8ByteCount -Value $branchName) -gt $maxBranchLength) { $originalBranchName = $branchName - $branchName = "$featureNum-$truncatedSuffix" + $truncatedSuffix = $branchSuffix + while ((Get-Utf8ByteCount -Value $branchName) -gt $maxBranchLength -and $truncatedSuffix.Length -gt 0) { + $truncatedSuffix = $truncatedSuffix.Substring(0, $truncatedSuffix.Length - 1) -replace '-$', '' + $branchName = New-BranchName -FeatureNum $featureNum -BranchSuffix $truncatedSuffix + } + if ((Get-Utf8ByteCount -Value $branchName) -gt $maxBranchLength) { + throw "Branch template prefix exceeds GitHub's 244-byte branch name limit." + } Write-Warning "[specify] Branch name exceeded GitHub's 244-byte limit" - Write-Warning "[specify] Original: $originalBranchName ($($originalBranchName.Length) bytes)" - Write-Warning "[specify] Truncated to: $branchName ($($branchName.Length) bytes)" + Write-Warning "[specify] Original: $originalBranchName ($(Get-Utf8ByteCount -Value $originalBranchName) bytes)" + Write-Warning "[specify] Truncated to: $branchName ($(Get-Utf8ByteCount -Value $branchName) bytes)" } if (-not $DryRun) { diff --git a/extensions/git/scripts/powershell/git-common.ps1 b/extensions/git/scripts/powershell/git-common.ps1 index 13ea7542c4..c54f8eecde 100644 --- a/extensions/git/scripts/powershell/git-common.ps1 +++ b/extensions/git/scripts/powershell/git-common.ps1 @@ -38,13 +38,13 @@ function Test-FeatureBranch { $raw = $Branch $Branch = Get-SpecKitEffectiveBranchName $raw - # Accept sequential prefix (3+ digits) but exclude malformed timestamps - # Malformed: 7-or-8 digit date + 6-digit time with no trailing slug (e.g. "2026031-143022" or "20260319-143022") - $hasMalformedTimestamp = ($Branch -match '^[0-9]{7}-[0-9]{6}-') -or ($Branch -match '^(?:\d{7}|\d{8})-\d{6}$') - $isSequential = ($Branch -match '^[0-9]{3,}-') -and (-not $hasMalformedTimestamp) - if (-not $isSequential -and $Branch -notmatch '^\d{8}-\d{6}-') { + # Accept sequential prefix (3+ digits), at the start or after namespace + # segments, but exclude malformed timestamps. + $hasMalformedTimestamp = ($Branch -match '(^|/)[0-9]{7}-[0-9]{6}-') -or ($Branch -match '(^|/)(?:\d{7}|\d{8})-\d{6}$') + $isSequential = ($Branch -match '(^|/)[0-9]{3,}-') -and (-not $hasMalformedTimestamp) + if (-not $isSequential -and $Branch -notmatch '(^|/)\d{8}-\d{6}-') { [Console]::Error.WriteLine("ERROR: Not on a feature branch. Current branch: $raw") - [Console]::Error.WriteLine("Feature branches should be named like: 001-feature-name, 1234-feature-name, or 20260319-143022-feature-name") + [Console]::Error.WriteLine("Feature branches should be named like: 001-feature-name, 1234-feature-name, 20260319-143022-feature-name, or /001-feature-name") return $false } return $true