update.sh

#!/bin/bash
#
# update.sh — safely upgrade an existing dotfiles install.
#
# Flow (mirrors how we update other projects):
#   1. run any one-off migrations for things that changed shape since your
#      last update (these run BEFORE the pull when they need to, so the pull
#      stays conflict-free),
#   2. pull the latest code safely (stashing local work if you're off main,
#      rebasing with autostash),
#   3. re-run the interactive installer (install.sh is idempotent) so new
#      config, symlinks, and software prompts get applied.
#
# Safe to run repeatedly.

set -o pipefail

ROOT_DIR="$(cd "$(dirname "$0")" && pwd)"
cd "$ROOT_DIR" || exit 1

# Colorized echo helpers (bot/ok/running/action/warn/error). Fall back to plain
# echo if the lib is missing.
if [ -f "$ROOT_DIR/lib_sh/echos.sh" ]; then
  . "$ROOT_DIR/lib_sh/echos.sh"
else
  ok()      { echo "[ok] $*"; }
  bot()     { echo "$*"; }
  running() { echo -n "$*: "; }
  action()  { echo "[action] $*"; }
  warn()    { echo "[warning] $*"; }
  error()   { echo "[error] $*"; }
fi

# Recovery state, surfaced at the end.
STASHED_BRANCH=""
BACKUP_DIR=""

bot "Dotfiles updater — I'll migrate anything that changed shape, pull the latest, and re-run the installer."

# Read a single key from an INI/git-config-style file WITHOUT expanding any
# [include]/[includeIf] directives — we want this file's own values only.
#   ini_get <file> <section> <key>
ini_get() {
  awk -v section="$2" -v key="$3" '
    /^[[:space:]]*\[/ {
      s = $0; gsub(/^[[:space:]]*\[|\][[:space:]].*$|\][[:space:]]*$/, "", s); gsub(/[[:space:]]+/, "", s)
      insec = (tolower(s) == tolower(section)); next
    }
    insec {
      line = $0; sub(/[#;].*/, "", line)
      n = index(line, "=")
      if (n > 0) {
        k = substr(line, 1, n - 1); v = substr(line, n + 1)
        gsub(/^[[:space:]]+|[[:space:]]+$/, "", k); gsub(/^[[:space:]]+|[[:space:]]+$/, "", v)
        if (tolower(k) == tolower(key)) { print v; exit }
      }
    }
  ' "$1"
}

# ###########################################################
# Migrations — one-off upgrades for things that changed shape.
# Each is a no-op when it isn't needed, so this is safe to re-run.
# ###########################################################

# #141: git identity used to be sed'd straight into the tracked
# homedir/.gitconfig, leaving every install permanently dirty and one stray
# `git add` away from committing personal info. Move it to the untracked
# ~/.gitconfig.local (pulled in via [include]) and restore the tracked file so
# the upcoming pull applies the new template cleanly.
migrate_gitconfig_identity() {
  local tracked="$ROOT_DIR/homedir/.gitconfig"
  local local_cfg="$HOME/.gitconfig.local"

  [ -f "$tracked" ] || return 0

  if [ -f "$local_cfg" ] && grep -q '^\[user\]' "$local_cfg"; then
    ok "git identity already lives in ~/.gitconfig.local — nothing to migrate"
    return 0
  fi

  local name email ghuser
  name=$(ini_get "$tracked" user name)
  email=$(ini_get "$tracked" user email)
  ghuser=$(ini_get "$tracked" github user)

  # The repo's own template placeholders are not a real identity.
  [ "$name" = "GITHUBFULLNAME" ] && name=""
  [ "$email" = "GITHUBEMAIL" ] && email=""
  [ "$ghuser" = "GITHUBUSER" ] && ghuser=""

  if [ -z "$name" ] && [ -z "$email" ] && [ -z "$ghuser" ]; then
    ok "no personal git identity baked into the tracked .gitconfig — nothing to migrate"
    return 0
  fi

  running "moving your git identity to ~/.gitconfig.local ($name, $email, $ghuser)"
  {
    echo "# Local git identity — NOT tracked by the dotfiles repo."
    echo "# Migrated by update.sh; edit freely. Pulled in via [include] in ~/.gitconfig."
    echo "[user]"
    [ -n "$name" ] && printf '\tname = %s\n' "$name"
    [ -n "$email" ] && printf '\temail = %s\n' "$email"
    if [ -n "$ghuser" ]; then
      echo "[github]"
      printf '\tuser = %s\n' "$ghuser"
    fi
  } >"$local_cfg"
  ok

  # The tracked file may carry other personal tweaks (e.g. includeIf blocks).
  # Back it up, then restore it to its committed state so the pull is clean.
  BACKUP_DIR="$HOME/.dotfiles_backup/$(date +%Y.%m.%d.%H.%M.%S)"
  mkdir -p "$BACKUP_DIR"
  cp "$tracked" "$BACKUP_DIR/.gitconfig"
  git checkout -- homedir/.gitconfig 2>/dev/null || true
  warn "backed up your previous homedir/.gitconfig to $BACKUP_DIR/.gitconfig"
  warn "if it had other personal git settings (e.g. includeIf blocks), copy them into ~/.gitconfig.local"
}

action "checking for migrations"
migrate_gitconfig_identity

# ###########################################################
# Pull the latest code safely
# ###########################################################
action "pulling the latest dotfiles"

origin_url=$(git remote get-url origin 2>/dev/null)
if [ -n "$origin_url" ]; then
  # redact any embedded credentials (https://user:token@host/...) before printing
  ok "origin: $(printf '%s' "$origin_url" | sed -E 's|://[^@/]+@|://***@|')"
fi

current_branch=$(git symbolic-ref -q --short HEAD 2>/dev/null)
if [ -n "$current_branch" ] && [ "$current_branch" != "main" ] && [ "$current_branch" != "master" ]; then
  if ! git diff --quiet || ! git diff --cached --quiet || [ -n "$(git ls-files --others --exclude-standard)" ]; then
    warn "stashing local changes on '$current_branch' so we can update from main"
    if git stash push -u -m "dotfiles-update-$(date +%s)" >/dev/null 2>&1; then
      STASHED_BRANCH="$current_branch"
    fi
  fi
  warn "switching from '$current_branch' to the main branch to update"
  git checkout main 2>/dev/null || git checkout master 2>/dev/null || true
fi

if ! git pull --rebase --autostash; then
  error "git pull failed. Resolve the issue shown above, then re-run ./update.sh"
  [ -n "$STASHED_BRANCH" ] && error "your stashed changes from '$STASHED_BRANCH' are safe — see: git stash list"
  exit 1
fi
ok "latest changes pulled"

running "updating submodules"
git submodule update --init --recursive >/dev/null 2>&1 || warn "submodule update reported issues (continuing)"
ok

# ###########################################################
# Re-run the installer interactively to apply the update
# ###########################################################
bot "re-running install.sh to apply the update (it's idempotent and will prompt you)…"
if ./install.sh; then
  bot "✅ dotfiles update complete!"
else
  error "install.sh exited with an error — review the output above and re-run ./install.sh when ready"
fi

# ###########################################################
# Recovery hints
# ###########################################################
[ -n "$BACKUP_DIR" ] && ok "your previous homedir/.gitconfig is backed up at: $BACKUP_DIR/.gitconfig"
if [ -n "$STASHED_BRANCH" ]; then
  ok "your local changes from '$STASHED_BRANCH' were stashed; restore with: git checkout '$STASHED_BRANCH' && git stash pop"
fi
ok "tip: reload your shell to pick up changes — exec \$SHELL -l"