safe-deploy

Safe Deploy

ℹ️ First, set expectations: before anything else, print one short line with this skill's version and its most recent change — the top entry of metadata.changelog above — e.g. safe-deploy vX.Y — recent: <summary>. Then proceed.

Safe deployment operations for docker-compose-based services over SSH. Three subcommands covering the full deploy lifecycle.

---

Prerequisites

Configure via environment variables or a local .env file:

SSH_HOST=<ip or hostname>
SSH_USER=<username, default: ubuntu>
SSH_KEY=<path to key, default: ~/.ssh/id_rsa>
APP_PATH=<remote app directory, default: ~/app>
COMPOSE_FILE=<compose file, default: docker-compose.yml>
BACKUP_DIR=<backup directory on remote, default: ~/backups>
DB_PATH=<path to database file, default: ~/app/app.db>

Connection setup (used in all subcommands):

source .env 2>/dev/null || true
SSH_HOST=${SSH_HOST:-""}
SSH_USER=${SSH_USER:-"ubuntu"}
SSH_KEY=${SSH_KEY:-"~/.ssh/id_rsa"}
APP_PATH=${APP_PATH:-"~/app"}
COMPOSE=${COMPOSE_FILE:-"docker-compose.yml"}
BACKUP_DIR=${BACKUP_DIR:-"~/backups"}
DB_PATH=${DB_PATH:-"$APP_PATH/app.db"}
RUN="ssh -i $SSH_KEY $SSH_USER@$SSH_HOST"

If SSH_HOST is empty, check for a scripts/run.sh wrapper.

---

Subcommand: update

Full deployment: backup → pull → rebuild → restart → validate.

Step U1: Pre-deploy Check

Check for running long-lived processes before proceeding:

$RUN "cd $APP_PATH && docker compose -f $COMPOSE ps --format json 2>/dev/null | grep -c running || docker compose -f $COMPOSE ps | grep -c Up"

Warn the user if active processes are running. Ask: "Proceed with deployment? Active processes may be interrupted."

Check disk space before proceeding:

$RUN "df -h $APP_PATH | tail -1 | awk '{print \$5}'"

If disk usage >85%, warn the user.

Step U2: Backup Database

Create a timestamped backup before any changes:

BACKUP_TS=$(date +%Y-%m-%d-%H%M%S)
$RUN "mkdir -p $BACKUP_DIR && cp $DB_PATH $BACKUP_DIR/app-${BACKUP_TS}.db 2>/dev/null && echo 'backup: ok' || echo 'backup: skipped (no DB found)'"