mirror of
https://github.com/github/spec-kit.git
synced 2026-03-24 06:13:08 +00:00
Co-authored-by: mnriem <15701806+mnriem@users.noreply.github.com> Agent-Logs-Url: https://github.com/github/spec-kit/sessions/809a1dbf-1301-4312-b4d2-e18f9b3e8b2f
50 lines
1.7 KiB
Markdown
50 lines
1.7 KiB
Markdown
---
|
|
description: "Validate current branch follows feature branch naming conventions"
|
|
---
|
|
|
|
# Validate Feature Branch
|
|
|
|
Validate that the current Git branch follows the expected feature branch naming conventions.
|
|
|
|
## Prerequisites
|
|
|
|
- Check if Git is available by running `git rev-parse --is-inside-work-tree 2>/dev/null`
|
|
- If Git is not available, output a warning and skip validation:
|
|
```
|
|
[specify] Warning: Git repository not detected; skipped branch validation
|
|
```
|
|
|
|
## Validation Rules
|
|
|
|
Get the current branch name:
|
|
|
|
```bash
|
|
git rev-parse --abbrev-ref HEAD
|
|
```
|
|
|
|
The branch name must match one of these patterns:
|
|
|
|
1. **Sequential**: `^[0-9]{3}-` (e.g., `001-feature-name`, `042-fix-bug`)
|
|
2. **Timestamp**: `^[0-9]{8}-[0-9]{6}-` (e.g., `20260319-143022-feature-name`)
|
|
|
|
## Execution
|
|
|
|
If on a feature branch (matches either pattern):
|
|
- Output: `✓ On feature branch: <branch-name>`
|
|
- Check if the corresponding spec directory exists under `specs/`:
|
|
- For sequential branches, look for `specs/<prefix>-*` where prefix matches the `###` portion
|
|
- For timestamp branches, look for `specs/<prefix>-*` where prefix matches the `YYYYMMDD-HHMMSS` portion
|
|
- If spec directory exists: `✓ Spec directory found: <path>`
|
|
- If spec directory missing: `⚠ No spec directory found for prefix <prefix>`
|
|
|
|
If NOT on a feature branch:
|
|
- Output: `✗ Not on a feature branch. Current branch: <branch-name>`
|
|
- Output: `Feature branches should be named like: 001-feature-name or 20260319-143022-feature-name`
|
|
|
|
## Graceful Degradation
|
|
|
|
If Git is not installed or the directory is not a Git repository:
|
|
- Check the `SPECIFY_FEATURE` environment variable as a fallback
|
|
- If set, validate that value against the naming patterns
|
|
- If not set, skip validation with a warning
|