refactor(update): replace git pull with fetch + reset for reliable sync

extract git utilities into scripts/git.sh module. this approach handles
accidental local commits that would cause rebase conflicts during updates.
This commit is contained in:
Yury Kossakovsky
2025-12-26 09:29:53 -07:00
parent 0709e3b6d3
commit 9b252a1287
7 changed files with 173 additions and 59 deletions

116
scripts/git.sh Normal file
View File

@@ -0,0 +1,116 @@
#!/bin/bash
# =============================================================================
# git.sh - Git utilities for n8n-install scripts
# =============================================================================
# Provides git-related functions for repository management.
#
# Functions:
# - require_git: Verify git is installed
# - git_get_current_branch: Get current branch name (main/develop)
# - git_sync_with_origin: Fetch and reset to origin/<branch>
# - git_configure_pull_rebase: Configure git to use rebase on pull
#
# Usage: source "$(dirname "$0")/git.sh"
# Note: Requires utils.sh to be sourced first for logging functions.
# =============================================================================
# Supported branches for this project
GIT_SUPPORTED_BRANCHES=("main" "develop")
GIT_DEFAULT_BRANCH="main"
#=============================================================================
# GIT CHECKS
#=============================================================================
# Check if git is installed
# Usage: require_git || exit 1
require_git() {
if ! command -v git &> /dev/null; then
log_error "'git' command not found. Please install git."
return 1
fi
return 0
}
#=============================================================================
# BRANCH MANAGEMENT
#=============================================================================
# Get current git branch name
# Returns default branch if on detached HEAD or unknown branch
# Usage: branch=$(git_get_current_branch)
git_get_current_branch() {
local branch
branch=$(git symbolic-ref --short HEAD 2>/dev/null || echo "")
# If empty (detached HEAD), use default
if [[ -z "$branch" ]]; then
echo "$GIT_DEFAULT_BRANCH"
return 0
fi
# Check if branch is in supported list
local is_supported=0
for supported in "${GIT_SUPPORTED_BRANCHES[@]}"; do
if [[ "$branch" == "$supported" ]]; then
is_supported=1
break
fi
done
if [[ $is_supported -eq 0 ]]; then
log_warning "Unknown branch '$branch', using $GIT_DEFAULT_BRANCH"
echo "$GIT_DEFAULT_BRANCH"
return 0
fi
echo "$branch"
}
#=============================================================================
# SYNC OPERATIONS
#=============================================================================
# Sync local repository with origin
# Fetches latest changes and resets to origin/<branch>
# This discards any local commits to ensure clean sync with remote
# Usage: git_sync_with_origin [target_branch]
# Returns: 0 on success, 1 on failure
git_sync_with_origin() {
local target_branch="${1:-}"
# Determine target branch if not specified
if [[ -z "$target_branch" ]]; then
target_branch=$(git_get_current_branch)
fi
# Fetch latest changes from origin
log_info "Fetching latest changes from origin..."
if ! git fetch origin; then
log_error "Git fetch failed. Check your internet connection."
return 1
fi
# Reset to origin/<branch>
log_info "Resetting to origin/$target_branch..."
if ! git reset --hard "origin/$target_branch"; then
log_error "Git reset to origin/$target_branch failed."
return 1
fi
log_info "Successfully synced with origin/$target_branch"
return 0
}
#=============================================================================
# CONFIGURATION
#=============================================================================
# Configure git to use rebase on pull (prevents merge commits)
# Usage: git_configure_pull_rebase
git_configure_pull_rebase() {
if [[ -z "$(git config --global pull.rebase 2>/dev/null)" ]]; then
log_info "Configuring git pull strategy (rebase)..."
git config --global pull.rebase true
fi
}