feat(hooks): implement thin shim pattern (GH#615)
Replace full shell script hooks with thin shims that delegate to 'bd hooks run <hook-name>'. This eliminates hook version drift - upgrading bd automatically updates hook behavior. Changes: - Add 'bd hooks run' subcommand with hook logic in Go - Convert templates to minimal shims (~17 lines each) - Shims use '# bd-shim v1' marker (format version, not bd version) - Update version checking to recognize shim format - Shims are never marked as "outdated" Benefits: - No more manual 'bd hooks install --force' after upgrades - Hook logic always matches installed bd version - Follows pattern used by husky, pre-commit, lefthook Migration: Run 'bd hooks install --force' one final time. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
Steve Yegge
@@ -1,89 +1,16 @@
|
||||
#!/bin/sh
|
||||
# bd-hooks-version: 0.30.7
|
||||
# bd-shim v1
|
||||
#
|
||||
# bd (beads) post-checkout hook
|
||||
# bd (beads) post-checkout hook - thin shim
|
||||
#
|
||||
# This hook syncs the bd database after a branch checkout:
|
||||
# 1. Checks if any .beads/*.jsonl file was updated
|
||||
# 2. Runs 'bd sync --import-only --no-git-history' to import changes
|
||||
#
|
||||
# Arguments provided by git:
|
||||
# $1 = ref of previous HEAD
|
||||
# $2 = ref of new HEAD
|
||||
# $3 = flag (1 if branch checkout, 0 if file checkout)
|
||||
#
|
||||
# Install: cp examples/git-hooks/post-checkout .git/hooks/post-checkout && chmod +x .git/hooks/post-checkout
|
||||
|
||||
# Only run on branch checkouts
|
||||
if [ "$3" != "1" ]; then
|
||||
exit 0
|
||||
fi
|
||||
|
||||
# Skip during rebase - git checks out commits during rebase and we must not
|
||||
# modify working tree files (like deletions.jsonl) or the rebase will fail
|
||||
if [ -d .git/rebase-merge ] || [ -d .git/rebase-apply ]; then
|
||||
exit 0
|
||||
fi
|
||||
# This shim delegates to 'bd hooks run post-checkout' which contains
|
||||
# the actual hook logic. This pattern ensures hook behavior is always
|
||||
# in sync with the installed bd version - no manual updates needed.
|
||||
|
||||
# Check if bd is available
|
||||
if ! command -v bd >/dev/null 2>&1; then
|
||||
# Silently skip - post-checkout is called frequently
|
||||
exit 0
|
||||
fi
|
||||
|
||||
# Check if we're in a bd workspace
|
||||
if [ ! -d .beads ]; then
|
||||
exit 0
|
||||
fi
|
||||
|
||||
# Detect git worktree: compare --git-dir and --git-common-dir
|
||||
GIT_DIR=$(git rev-parse --git-dir 2>/dev/null)
|
||||
GIT_COMMON_DIR=$(git rev-parse --git-common-dir 2>/dev/null)
|
||||
if [ -n "$GIT_DIR" ] && [ -n "$GIT_COMMON_DIR" ]; then
|
||||
GIT_DIR_ABS=$(cd "$GIT_DIR" 2>/dev/null && pwd || echo "$GIT_DIR")
|
||||
GIT_COMMON_DIR_ABS=$(cd "$GIT_COMMON_DIR" 2>/dev/null && pwd || echo "$GIT_COMMON_DIR")
|
||||
|
||||
if [ "$GIT_DIR_ABS" != "$GIT_COMMON_DIR_ABS" ]; then
|
||||
# We're in a git worktree
|
||||
cat >&2 <<'EOF'
|
||||
|
||||
╔══════════════════════════════════════════════════════════════════════════╗
|
||||
║ Welcome to beads in git worktree! ║
|
||||
╠══════════════════════════════════════════════════════════════════════════╣
|
||||
║ Note: Daemon mode is not recommended with git worktrees. ║
|
||||
║ Worktrees share the same database, and the daemon may commit changes ║
|
||||
║ to the wrong branch. ║
|
||||
║ ║
|
||||
║ RECOMMENDED: Disable daemon for this session: ║
|
||||
║ export BEADS_NO_DAEMON=1 ║
|
||||
║ ║
|
||||
║ For more information: ║
|
||||
║ - Run: bd doctor ║
|
||||
║ - Read: docs/GIT_INTEGRATION.md (lines 10-53) ║
|
||||
║ ║
|
||||
║ Issue tracking: bd-dc9 ║
|
||||
╚══════════════════════════════════════════════════════════════════════════╝
|
||||
|
||||
EOF
|
||||
fi
|
||||
fi
|
||||
|
||||
# Check if any JSONL file exists in .beads/
|
||||
if ! ls .beads/*.jsonl >/dev/null 2>&1; then
|
||||
exit 0
|
||||
fi
|
||||
|
||||
# Run bd sync --import-only --no-git-history to import the updated JSONL
|
||||
# --no-git-history prevents writes to deletions.jsonl (critical during rebase)
|
||||
if ! output=$(bd sync --import-only --no-git-history 2>&1); then
|
||||
echo "Warning: Failed to sync bd changes after checkout" >&2
|
||||
echo "$output" >&2
|
||||
echo "" >&2
|
||||
echo "Run 'bd doctor --fix' to diagnose and repair" >&2
|
||||
# Don't fail the checkout, just warn
|
||||
fi
|
||||
|
||||
# Run quick health check (silent on success, hints if issues found)
|
||||
# This catches version mismatches, outdated hooks, etc.
|
||||
bd doctor --check-health 2>/dev/null || true
|
||||
|
||||
exit 0
|
||||
exec bd hooks run post-checkout "$@"
|
||||
|
||||
@@ -1,56 +1,18 @@
|
||||
#!/bin/sh
|
||||
# bd-hooks-version: 0.30.7
|
||||
# bd-shim v1
|
||||
#
|
||||
# bd (beads) post-merge hook
|
||||
# bd (beads) post-merge hook - thin shim
|
||||
#
|
||||
# This hook syncs the bd database after a git pull or merge:
|
||||
# 1. Checks if any .beads/*.jsonl file was updated
|
||||
# 2. Runs 'bd sync --import-only --no-git-history' to import changes
|
||||
#
|
||||
# Installation:
|
||||
# cp examples/git-hooks/post-merge .git/hooks/post-merge
|
||||
# chmod +x .git/hooks/post-merge
|
||||
#
|
||||
# Or use the install script:
|
||||
# examples/git-hooks/install.sh
|
||||
|
||||
# Skip during rebase - git may run post-merge during rebase operations
|
||||
# and we must not modify working tree files or the rebase will fail
|
||||
if [ -d .git/rebase-merge ] || [ -d .git/rebase-apply ]; then
|
||||
exit 0
|
||||
fi
|
||||
# This shim delegates to 'bd hooks run post-merge' which contains
|
||||
# the actual hook logic. This pattern ensures hook behavior is always
|
||||
# in sync with the installed bd version - no manual updates needed.
|
||||
|
||||
# Check if bd is available
|
||||
if ! command -v bd >/dev/null 2>&1; then
|
||||
echo "Warning: bd command not found, skipping post-merge sync" >&2
|
||||
echo "Warning: bd command not found in PATH, skipping post-merge hook" >&2
|
||||
echo " Install bd: brew install steveyegge/tap/bd" >&2
|
||||
echo " Or add bd to your PATH" >&2
|
||||
exit 0
|
||||
fi
|
||||
|
||||
# Check if we're in a bd workspace
|
||||
if [ ! -d .beads ]; then
|
||||
# Not a bd workspace, nothing to do
|
||||
exit 0
|
||||
fi
|
||||
|
||||
# Check if any JSONL file exists in .beads/
|
||||
if ! ls .beads/*.jsonl >/dev/null 2>&1; then
|
||||
exit 0
|
||||
fi
|
||||
|
||||
# Run bd sync --import-only --no-git-history to import the updated JSONL
|
||||
# --no-git-history prevents writes to deletions.jsonl during hook operations
|
||||
# This is more robust than direct import as it handles all edge cases
|
||||
# Capture both stdout and stderr to show user what went wrong
|
||||
if ! output=$(bd sync --import-only --no-git-history 2>&1); then
|
||||
echo "Warning: Failed to sync bd changes after merge" >&2
|
||||
echo "$output" >&2
|
||||
echo "" >&2
|
||||
echo "Run 'bd doctor --fix' to diagnose and repair" >&2
|
||||
# Don't fail the merge, just warn
|
||||
fi
|
||||
|
||||
# Run quick health check (silent on success, hints if issues found)
|
||||
# This catches version mismatches, outdated hooks, etc.
|
||||
bd doctor --check-health 2>/dev/null || true
|
||||
|
||||
exit 0
|
||||
exec bd hooks run post-merge "$@"
|
||||
|
||||
@@ -1,63 +1,18 @@
|
||||
#!/bin/sh
|
||||
# bd-hooks-version: 0.30.7
|
||||
# bd-shim v1
|
||||
#
|
||||
# bd (beads) pre-commit hook
|
||||
# bd (beads) pre-commit hook - thin shim
|
||||
#
|
||||
# This hook ensures that any pending bd issue changes are flushed to
|
||||
# .beads/issues.jsonl before the commit is created, preventing the
|
||||
# race condition where daemon auto-flush fires after the commit.
|
||||
#
|
||||
# When sync-branch is configured in config.yaml, .beads changes are committed
|
||||
# to a separate branch via worktree, so auto-staging is skipped.
|
||||
#
|
||||
# Installation:
|
||||
# cp examples/git-hooks/pre-commit .git/hooks/pre-commit
|
||||
# chmod +x .git/hooks/pre-commit
|
||||
#
|
||||
# Or use the install script:
|
||||
# examples/git-hooks/install.sh
|
||||
# This shim delegates to 'bd hooks run pre-commit' which contains
|
||||
# the actual hook logic. This pattern ensures hook behavior is always
|
||||
# in sync with the installed bd version - no manual updates needed.
|
||||
|
||||
# Check if bd is available
|
||||
if ! command -v bd >/dev/null 2>&1; then
|
||||
echo "Warning: bd command not found, skipping pre-commit flush" >&2
|
||||
echo "Warning: bd command not found in PATH, skipping pre-commit hook" >&2
|
||||
echo " Install bd: brew install steveyegge/tap/bd" >&2
|
||||
echo " Or add bd to your PATH" >&2
|
||||
exit 0
|
||||
fi
|
||||
|
||||
# Check if we're in a bd workspace
|
||||
if [ ! -d .beads ]; then
|
||||
# Not a bd workspace, nothing to do
|
||||
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)
|
||||
# Use head -1 to only take first match if file is malformed
|
||||
SYNC_BRANCH=$(grep -E '^sync-branch:' .beads/config.yaml 2>/dev/null | head -1 | sed 's/^sync-branch:[[:space:]]*//' | sed 's/^["'"'"']//' | sed 's/["'"'"']$//')
|
||||
fi
|
||||
if [ -n "$SYNC_BRANCH" ]; then
|
||||
# sync-branch is configured, skip flush and auto-staging
|
||||
# Changes are synced to the separate branch via 'bd sync'
|
||||
exit 0
|
||||
fi
|
||||
|
||||
# Flush pending changes to JSONL
|
||||
# Use --flush-only to skip git operations (we're already in a git hook)
|
||||
# Suppress output unless there's an error
|
||||
# Note: We warn but don't fail - this allows commits to proceed even if
|
||||
# beads has issues (e.g., user removed .beads from their branch)
|
||||
if ! bd sync --flush-only >/dev/null 2>&1; then
|
||||
echo "Warning: Failed to flush bd changes to JSONL" >&2
|
||||
echo "Run 'bd sync --flush-only' manually to diagnose" >&2
|
||||
# Don't block the commit - user may have removed beads or have other issues
|
||||
fi
|
||||
|
||||
# Stage all tracked JSONL files (beads.jsonl, issues.jsonl for backward compat, deletions.jsonl for deletion propagation)
|
||||
# git add is harmless if file doesn't exist
|
||||
for f in .beads/beads.jsonl .beads/issues.jsonl .beads/deletions.jsonl; do
|
||||
[ -f "$f" ] && git add "$f" 2>/dev/null || true
|
||||
done
|
||||
|
||||
exit 0
|
||||
exec bd hooks run pre-commit "$@"
|
||||
|
||||
@@ -1,130 +1,18 @@
|
||||
#!/bin/sh
|
||||
# bd-hooks-version: 0.30.7
|
||||
# bd-shim v1
|
||||
#
|
||||
# bd (beads) pre-push hook
|
||||
# bd (beads) pre-push hook - thin shim
|
||||
#
|
||||
# This hook prevents pushing stale JSONL by:
|
||||
# 1. Flushing any pending in-memory changes to JSONL (if bd available)
|
||||
# 2. Checking for uncommitted changes (staged, unstaged, untracked, deleted)
|
||||
# 3. Failing the push with clear instructions if changes found
|
||||
#
|
||||
# When sync-branch is configured in config.yaml, .beads changes are committed
|
||||
# to a separate branch via worktree, so the uncommitted check is skipped.
|
||||
#
|
||||
# The pre-commit hook already exports changes, but this catches:
|
||||
# - Changes made between commit and push
|
||||
# - Pending debounced flushes (5s daemon delay)
|
||||
#
|
||||
# Installation:
|
||||
# cp examples/git-hooks/pre-push .git/hooks/pre-push
|
||||
# chmod +x .git/hooks/pre-push
|
||||
#
|
||||
# Or use the install script:
|
||||
# examples/git-hooks/install.sh
|
||||
# This shim delegates to 'bd hooks run pre-push' which contains
|
||||
# the actual hook logic. This pattern ensures hook behavior is always
|
||||
# in sync with the installed bd version - no manual updates needed.
|
||||
|
||||
# Check if we're in a bd workspace
|
||||
if [ ! -d .beads ]; then
|
||||
# Not a bd workspace, nothing to do
|
||||
# Check if bd is available
|
||||
if ! command -v bd >/dev/null 2>&1; then
|
||||
echo "Warning: bd command not found in PATH, skipping pre-push hook" >&2
|
||||
echo " Install bd: brew install steveyegge/tap/bd" >&2
|
||||
echo " Or add bd to your PATH" >&2
|
||||
exit 0
|
||||
fi
|
||||
|
||||
# Skip if bd sync is already in progress (GH#532: prevents circular error)
|
||||
# bd sync sets this env var when pushing from worktree
|
||||
if [ -n "$BD_SYNC_IN_PROGRESS" ]; then
|
||||
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)
|
||||
# Use head -1 to only take first match if file is malformed
|
||||
SYNC_BRANCH=$(grep -E '^sync-branch:' .beads/config.yaml 2>/dev/null | head -1 | 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
|
||||
# This prevents the race where a debounced flush lands after the check
|
||||
if command -v bd >/dev/null 2>&1; then
|
||||
bd sync --flush-only >/dev/null 2>&1 || true
|
||||
fi
|
||||
|
||||
# Collect all tracked or existing JSONL files (beads.jsonl, issues.jsonl for backward compat, deletions.jsonl for deletion propagation)
|
||||
FILES=""
|
||||
for f in .beads/beads.jsonl .beads/issues.jsonl .beads/deletions.jsonl; do
|
||||
# Include file if it exists in working tree OR is tracked by git (even if deleted)
|
||||
if git ls-files --error-unmatch "$f" >/dev/null 2>&1 || [ -f "$f" ]; then
|
||||
FILES="$FILES $f"
|
||||
fi
|
||||
done
|
||||
|
||||
# Check for any uncommitted changes using porcelain status
|
||||
# This catches: staged, unstaged, untracked, deleted, renamed, and conflicts
|
||||
if [ -n "$FILES" ]; then
|
||||
# shellcheck disable=SC2086
|
||||
if [ -n "$(git status --porcelain -- $FILES 2>/dev/null)" ]; then
|
||||
echo "❌ Error: Uncommitted changes detected" >&2
|
||||
echo "" >&2
|
||||
echo "Before pushing, ensure all changes are committed. This includes:" >&2
|
||||
echo " • bd JSONL updates (run 'bd sync')" >&2
|
||||
echo " • any other modified files (run 'git status' to review)" >&2
|
||||
echo "" >&2
|
||||
|
||||
# Check if bd is available and offer auto-sync
|
||||
if command -v bd >/dev/null 2>&1; then
|
||||
# Check if we're in an interactive terminal
|
||||
if [ -t 0 ]; then
|
||||
echo "Would you like to run 'bd sync' now to commit and push these changes? [y/N]" >&2
|
||||
read -r response
|
||||
case "$response" in
|
||||
[yY][eE][sS]|[yY])
|
||||
echo "" >&2
|
||||
echo "Running: bd sync" >&2
|
||||
if bd sync; then
|
||||
echo "" >&2
|
||||
echo "✓ Sync complete. Continuing with push..." >&2
|
||||
exit 0
|
||||
else
|
||||
echo "" >&2
|
||||
echo "❌ Sync failed. Push aborted." >&2
|
||||
exit 1
|
||||
fi
|
||||
;;
|
||||
*)
|
||||
echo "" >&2
|
||||
echo "Push aborted. Run 'bd sync' manually when ready:" >&2
|
||||
echo "" >&2
|
||||
echo " bd sync" >&2
|
||||
echo " git push" >&2
|
||||
echo "" >&2
|
||||
exit 1
|
||||
;;
|
||||
esac
|
||||
else
|
||||
# Non-interactive: just show the message
|
||||
echo "Run 'bd sync' to commit these changes:" >&2
|
||||
echo "" >&2
|
||||
echo " bd sync" >&2
|
||||
echo "" >&2
|
||||
exit 1
|
||||
fi
|
||||
else
|
||||
# bd not available, fall back to manual git commands
|
||||
echo "Please commit the updated JSONL before pushing:" >&2
|
||||
echo "" >&2
|
||||
# shellcheck disable=SC2086
|
||||
echo " git add $FILES" >&2
|
||||
echo ' git commit -m "Update bd JSONL"' >&2
|
||||
echo " git push" >&2
|
||||
echo "" >&2
|
||||
exit 1
|
||||
fi
|
||||
fi
|
||||
fi
|
||||
|
||||
exit 0
|
||||
exec bd hooks run pre-push "$@"
|
||||
|
||||
Reference in New Issue
Block a user