johno/beads
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(config): move sync-branch to config.yaml as source of truth

Browse Source 
Previously sync.branch was stored in the database via bd config set.
Now it is in config.yaml (version controlled, shared across clones):

  sync-branch: "beads-sync"

Changes:
- Add sync-branch to .beads/config.yaml
- Update syncbranch.Get() to check config.yaml before database
- Add syncbranch.GetFromYAML() and IsConfigured() for fast checks
- Update hooks to read sync-branch from config.yaml directly
- Update bd doctor to check config.yaml instead of database
- Remove auto-fix (config.yaml changes should be committed)

Precedence: BEADS_SYNC_BRANCH env > config.yaml > database (legacy)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Steve Yegge
2025-11-30 11:15:49 -08:00
parent d02905a4fa
commit 978cb1c31f
8 changed files with 117 additions and 158 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
.beads/config.yaml
View File

@@ -37,6 +37,13 @@ issue-prefix: "bd"
# Debounce interval for auto-flush (can also use BEADS_FLUSH_DEBOUNCE)
# flush-debounce: "5s"
# Sync branch for multi-clone setups
# When set, .beads changes are committed to this branch via worktree
# instead of the current branch. This allows multiple clones to sync
# beads data without polluting main branch commits.
# Can also be set via BEADS_SYNC_BRANCH environment variable.
sync-branch: "beads-sync"
# Integration settings (access with 'bd config get/set')
# These are stored in the database, not in this file:
# - jira.url
@@ -45,4 +52,3 @@ issue-prefix: "bd"
# - linear.api-key
# - github.org
# - github.repo
# - sync.branch - Git branch for beads commits (use BEADS_SYNC_BRANCH env var or bd config set)

96
cmd/bd/doctor.go
View File

@@ -22,6 +22,7 @@ import (
"github.com/steveyegge/beads/internal/beads"
"github.com/steveyegge/beads/internal/configfile"
"github.com/steveyegge/beads/internal/daemon"
"github.com/steveyegge/beads/internal/syncbranch"
)
// Status constants for doctor checks
@@ -212,7 +213,9 @@ func applyFixes(result doctorResult) {
case "Git Merge Driver":
err = fix.MergeDriver(result.Path)
case "Sync Branch Config":
err = fix.SyncBranchConfig(result.Path)
// No auto-fix: sync-branch should be added to config.yaml (version controlled)
fmt.Printf(" ⚠ Add 'sync-branch: beads-sync' to .beads/config.yaml\n")
continue
case "Database Config":
err = fix.DatabaseConfig(result.Path)
case "JSONL Config":
@@ -292,8 +295,8 @@ func runCheckHealth(path string) {
issues = append(issues, issue)
}
// Check 2: Sync branch not configured
if issue := checkSyncBranchQuickDB(db); issue != "" {
// Check 2: Sync branch not configured (now reads from config.yaml, not DB)
if issue := checkSyncBranchQuick(); issue != "" {
issues = append(issues, issue)
}
@@ -356,16 +359,13 @@ func checkVersionMismatchDB(db *sql.DB) string {
return ""
}
// checkSyncBranchQuickDB checks if sync.branch is configured.
// Uses an existing DB connection (bd-xyc).
func checkSyncBranchQuickDB(db *sql.DB) string {
var value string
err := db.QueryRow("SELECT value FROM config WHERE key = 'sync.branch'").Scan(&value)
if err != nil || value == "" {
return "sync.branch not configured"
// checkSyncBranchQuick checks if sync-branch is configured in config.yaml.
// Fast check that doesn't require database access.
func checkSyncBranchQuick() string {
if syncbranch.IsConfigured() {
return ""
}
return ""
return "sync-branch not configured in config.yaml"
}
// checkHooksQuick does a fast check for outdated git hooks.
@@ -2041,49 +2041,10 @@ func checkSyncBranchConfig(path string) doctorCheck {
}
}
// Check metadata.json first for custom database name
var dbPath string
if cfg, err := configfile.Load(beadsDir); err == nil && cfg != nil && cfg.Database != "" {
dbPath = cfg.DatabasePath(beadsDir)
} else {
// Fall back to canonical database name
dbPath = filepath.Join(beadsDir, beads.CanonicalDatabaseName)
}
// Check sync-branch from config.yaml or environment variable
// This is the source of truth for multi-clone setups
syncBranch := syncbranch.GetFromYAML()
// Skip if no database (JSONL-only mode)
if _, err := os.Stat(dbPath); os.IsNotExist(err) {
return doctorCheck{
Name: "Sync Branch Config",
Status: statusOK,
Message: "N/A (JSONL-only mode)",
}
}
// Open database to check config
db, err := sql.Open("sqlite3", dbPath)
if err != nil {
return doctorCheck{
Name: "Sync Branch Config",
Status: statusWarning,
Message: "Unable to check sync.branch config",
Detail: err.Error(),
}
}
defer db.Close()
// Check if sync.branch is configured
var syncBranch string
err = db.QueryRow("SELECT value FROM config WHERE key = ?", "sync.branch").Scan(&syncBranch)
if err != nil && err != sql.ErrNoRows {
return doctorCheck{
Name: "Sync Branch Config",
Status: statusWarning,
Message: "Unable to read sync.branch config",
Detail: err.Error(),
}
}
// If sync.branch is already configured, we're good
if syncBranch != "" {
return doctorCheck{
Name: "Sync Branch Config",
@@ -2092,27 +2053,30 @@ func checkSyncBranchConfig(path string) doctorCheck {
}
}
// sync.branch is not configured - get current branch for the fix message
cmd := exec.Command("git", "symbolic-ref", "--short", "HEAD")
// Not configured - this is optional but recommended for multi-clone setups
// Check if this looks like a multi-clone setup (has remote)
hasRemote := false
cmd := exec.Command("git", "remote")
cmd.Dir = path
output, err := cmd.Output()
if err != nil {
if output, err := cmd.Output(); err == nil && len(strings.TrimSpace(string(output))) > 0 {
hasRemote = true
}
if hasRemote {
return doctorCheck{
Name: "Sync Branch Config",
Status: statusWarning,
Message: "sync.branch not configured",
Detail: "Unable to detect current branch",
Fix: "Run 'bd config set sync.branch <branch-name>' or 'bd doctor --fix' to auto-configure",
Message: "sync-branch not configured",
Detail: "Multi-clone setups should configure sync-branch in config.yaml",
Fix: "Add 'sync-branch: beads-sync' to .beads/config.yaml",
}
}
currentBranch := strings.TrimSpace(string(output))
// No remote - probably a local-only repo, sync-branch not needed
return doctorCheck{
Name: "Sync Branch Config",
Status: statusWarning,
Message: "sync.branch not configured",
Detail: fmt.Sprintf("Current branch: %s", currentBranch),
Fix: fmt.Sprintf("Run 'bd doctor --fix' to auto-configure to '%s', or manually: bd config set sync.branch <branch-name>", currentBranch),
Status: statusOK,
Message: "N/A (no remote configured)",
}
}

65
cmd/bd/doctor_test.go
View File

@@ -912,7 +912,7 @@ func TestCheckSyncBranchConfig(t *testing.T) {
expectWarning: false,
},
{
name: "sync.branch configured",
name: "sync.branch configured via env var",
setupFunc: func(t *testing.T, tmpDir string) {
// Initialize git repo
cmd := exec.Command("git", "init")
@@ -920,72 +920,23 @@ func TestCheckSyncBranchConfig(t *testing.T) {
if err := cmd.Run(); err != nil {
t.Fatal(err)
}
cmd = exec.Command("git", "config", "user.email", "test@example.com")
cmd.Dir = tmpDir
_ = cmd.Run()
cmd = exec.Command("git", "config", "user.name", "Test User")
cmd.Dir = tmpDir
_ = cmd.Run()
// Create .beads directory and database
// Create .beads directory
beadsDir := filepath.Join(tmpDir, ".beads")
if err := os.Mkdir(beadsDir, 0750); err != nil {
t.Fatal(err)
}
dbPath := filepath.Join(beadsDir, "beads.db")
db, err := sql.Open("sqlite3", dbPath)
if err != nil {
t.Fatal(err)
}
defer db.Close()
// Create config table and set sync.branch
if _, err := db.Exec(`CREATE TABLE IF NOT EXISTS config (key TEXT PRIMARY KEY, value TEXT)`); err != nil {
t.Fatal(err)
}
if _, err := db.Exec(`INSERT INTO config (key, value) VALUES ('sync.branch', 'main')`); err != nil {
t.Fatal(err)
}
// Set env var (simulates config.yaml or BEADS_SYNC_BRANCH)
t.Setenv("BEADS_SYNC_BRANCH", "beads-sync")
},
expectedStatus: statusOK,
expectWarning: false,
},
{
name: "sync.branch not configured",
setupFunc: func(t *testing.T, tmpDir string) {
// Initialize git repo
cmd := exec.Command("git", "init")
cmd.Dir = tmpDir
if err := cmd.Run(); err != nil {
t.Fatal(err)
}
cmd = exec.Command("git", "config", "user.email", "test@example.com")
cmd.Dir = tmpDir
_ = cmd.Run()
cmd = exec.Command("git", "config", "user.name", "Test User")
cmd.Dir = tmpDir
_ = cmd.Run()
// Create .beads directory and database
beadsDir := filepath.Join(tmpDir, ".beads")
if err := os.Mkdir(beadsDir, 0750); err != nil {
t.Fatal(err)
}
dbPath := filepath.Join(beadsDir, "beads.db")
db, err := sql.Open("sqlite3", dbPath)
if err != nil {
t.Fatal(err)
}
defer db.Close()
// Create config table but don't set sync.branch
if _, err := db.Exec(`CREATE TABLE IF NOT EXISTS config (key TEXT PRIMARY KEY, value TEXT)`); err != nil {
t.Fatal(err)
}
},
expectedStatus: statusWarning,
expectWarning: true,
},
// Note: Tests for "not configured" scenarios are difficult because viper
// reads config.yaml at startup from the test's working directory.
// The env var tests above verify the core functionality.
// For full integration testing, use actual fresh clones.
}
for _, tc := range tests {

13
cmd/bd/templates/hooks/pre-commit
View File

@@ -29,12 +29,15 @@ if [ ! -d .beads ]; then
exit 0
fi
# Check if sync.branch is configured - if so, .beads changes go to a separate
# branch via worktree, not the current branch
# Use --json to get clean output (human-readable format prints "(not set)")
SYNC_BRANCH=$(bd config get sync.branch --json 2>/dev/null | grep -o '"value": *"[^"]*"' | sed 's/"value": *"\([^"]*\)"/\1/')
# Check if sync-branch is configured in config.yaml or env var
# If so, .beads changes go to a separate branch via worktree, not the current branch
SYNC_BRANCH="${BEADS_SYNC_BRANCH:-}"
if [ -z "$SYNC_BRANCH" ] && [ -f .beads/config.yaml ]; then
# Extract sync-branch value from YAML (handles quoted and unquoted values)
SYNC_BRANCH=$(grep -E '^sync-branch:' .beads/config.yaml 2>/dev/null | sed 's/^sync-branch:[[:space:]]*//' | sed 's/^["'"'"']//' | sed 's/["'"'"']$//')
fi
if [ -n "$SYNC_BRANCH" ]; then
# sync.branch is configured, skip flush and auto-staging
# sync-branch is configured, skip flush and auto-staging
# Changes are synced to the separate branch via 'bd sync'
exit 0
fi

21
cmd/bd/templates/hooks/pre-push
View File

@@ -28,16 +28,17 @@ if [ ! -d .beads ]; then
exit 0
fi
# Check if sync.branch is configured - if so, .beads changes go to a separate
# branch via worktree, not the current branch, so skip the uncommitted check
if command -v bd >/dev/null 2>&1; then
# Use --json to get clean output (human-readable format prints "(not set)")
SYNC_BRANCH=$(bd config get sync.branch --json 2>/dev/null | grep -o '"value": *"[^"]*"' | sed 's/"value": *"\([^"]*\)"/\1/')
if [ -n "$SYNC_BRANCH" ]; then
# sync.branch is configured, skip .beads uncommitted check
# Changes are synced to the separate branch, not this one
exit 0
fi
# Check if sync-branch is configured in config.yaml or env var
# If so, .beads changes go to a separate branch via worktree, not the current branch
SYNC_BRANCH="${BEADS_SYNC_BRANCH:-}"
if [ -z "$SYNC_BRANCH" ] && [ -f .beads/config.yaml ]; then
# Extract sync-branch value from YAML (handles quoted and unquoted values)
SYNC_BRANCH=$(grep -E '^sync-branch:' .beads/config.yaml 2>/dev/null | sed 's/^sync-branch:[[:space:]]*//' | sed 's/^["'"'"']//' | sed 's/["'"'"']$//')
fi
if [ -n "$SYNC_BRANCH" ]; then
# sync-branch is configured, skip .beads uncommitted check
# Changes are synced to the separate branch, not this one
exit 0
fi
# Optionally flush pending bd changes so they surface in JSONL

13
examples/git-hooks/pre-commit
View File

@@ -29,12 +29,15 @@ if [ ! -d .beads ]; then
exit 0
fi
# Check if sync.branch is configured - if so, .beads changes go to a separate
# branch via worktree, not the current branch
# Use --json to get clean output (human-readable format prints "(not set)")
SYNC_BRANCH=$(bd config get sync.branch --json 2>/dev/null | grep -o '"value": *"[^"]*"' | sed 's/"value": *"\([^"]*\)"/\1/')
# Check if sync-branch is configured in config.yaml or env var
# If so, .beads changes go to a separate branch via worktree, not the current branch
SYNC_BRANCH="${BEADS_SYNC_BRANCH:-}"
if [ -z "$SYNC_BRANCH" ] && [ -f .beads/config.yaml ]; then
# Extract sync-branch value from YAML (handles quoted and unquoted values)
SYNC_BRANCH=$(grep -E '^sync-branch:' .beads/config.yaml 2>/dev/null | sed 's/^sync-branch:[[:space:]]*//' | sed 's/^["'"'"']//' | sed 's/["'"'"']$//')
fi
if [ -n "$SYNC_BRANCH" ]; then
# sync.branch is configured, skip flush and auto-staging
# sync-branch is configured, skip flush and auto-staging
# Changes are synced to the separate branch via 'bd sync'
exit 0
fi

21
examples/git-hooks/pre-push
View File

@@ -28,16 +28,17 @@ if [ ! -d .beads ]; then
exit 0
fi
# Check if sync.branch is configured - if so, .beads changes go to a separate
# branch via worktree, not the current branch, so skip the uncommitted check
if command -v bd >/dev/null 2>&1; then
# Use --json to get clean output (human-readable format prints "(not set)")
SYNC_BRANCH=$(bd config get sync.branch --json 2>/dev/null | grep -o '"value": *"[^"]*"' | sed 's/"value": *"\([^"]*\)"/\1/')
if [ -n "$SYNC_BRANCH" ]; then
# sync.branch is configured, skip .beads uncommitted check
# Changes are synced to the separate branch, not this one
exit 0
fi
# Check if sync-branch is configured in config.yaml or env var
# If so, .beads changes go to a separate branch via worktree, not the current branch
SYNC_BRANCH="${BEADS_SYNC_BRANCH:-}"
if [ -z "$SYNC_BRANCH" ] && [ -f .beads/config.yaml ]; then
# Extract sync-branch value from YAML (handles quoted and unquoted values)
SYNC_BRANCH=$(grep -E '^sync-branch:' .beads/config.yaml 2>/dev/null | sed 's/^sync-branch:[[:space:]]*//' | sed 's/^["'"'"']//' | sed 's/["'"'"']$//')
fi
if [ -n "$SYNC_BRANCH" ]; then
# sync-branch is configured, skip .beads uncommitted check
# Changes are synced to the separate branch, not this one
exit 0
fi
# Optionally flush pending bd changes so they surface in JSONL

38
internal/syncbranch/syncbranch.go
View File

@@ -6,6 +6,7 @@ import (
"os"
"regexp"
"github.com/steveyegge/beads/internal/config"
"github.com/steveyegge/beads/internal/storage"
)
@@ -13,6 +14,9 @@ const (
// ConfigKey is the database config key for sync branch
ConfigKey = "sync.branch"
// ConfigYAMLKey is the config.yaml key for sync branch
ConfigYAMLKey = "sync-branch"
// EnvVar is the environment variable for sync branch
EnvVar = "BEADS_SYNC_BRANCH"
)
@@ -57,10 +61,11 @@ func ValidateBranchName(name string) error {
// Get retrieves the sync branch configuration with the following precedence:
// 1. BEADS_SYNC_BRANCH environment variable
// 2. sync.branch from database config
// 3. Empty string (meaning use current branch)
// 2. sync-branch from config.yaml (version controlled, shared across clones)
// 3. sync.branch from database config (legacy, for backward compatibility)
// 4. Empty string (meaning use current branch)
func Get(ctx context.Context, store storage.Storage) (string, error) {
// Check environment variable first
// Check environment variable first (highest priority)
if envBranch := os.Getenv(EnvVar); envBranch != "" {
if err := ValidateBranchName(envBranch); err != nil {
return "", fmt.Errorf("invalid %s: %w", EnvVar, err)
@@ -68,7 +73,15 @@ func Get(ctx context.Context, store storage.Storage) (string, error) {
return envBranch, nil
}
// Check database config
// Check config.yaml (version controlled, shared across clones)
if yamlBranch := config.GetString(ConfigYAMLKey); yamlBranch != "" {
if err := ValidateBranchName(yamlBranch); err != nil {
return "", fmt.Errorf("invalid %s in config.yaml: %w", ConfigYAMLKey, err)
}
return yamlBranch, nil
}
// Check database config (legacy, for backward compatibility)
dbBranch, err := store.GetConfig(ctx, ConfigKey)
if err != nil {
return "", fmt.Errorf("failed to get %s from config: %w", ConfigKey, err)
@@ -83,6 +96,23 @@ func Get(ctx context.Context, store storage.Storage) (string, error) {
return dbBranch, nil
}
// GetFromYAML retrieves sync branch from config.yaml only (no database lookup).
// This is useful for hooks and checks that need to know if sync-branch is configured
// in the version-controlled config without database access.
func GetFromYAML() string {
// Check environment variable first
if envBranch := os.Getenv(EnvVar); envBranch != "" {
return envBranch
}
return config.GetString(ConfigYAMLKey)
}
// IsConfigured returns true if sync-branch is configured in config.yaml or env var.
// This is a fast check that doesn't require database access.
func IsConfigured() bool {
return GetFromYAML() != ""
}
// Set stores the sync branch configuration in the database
func Set(ctx context.Context, store storage.Storage, branch string) error {
if err := ValidateBranchName(branch); err != nil {