Instruction file imported from OlyForge3D/PrintFarmer (.github/instructions/scripts.instructions.md). Copyright stays with the author.

description: 'PrintFarmer scripts area: deployment automation, local dev helpers, Docker compose generation, and utility tooling' applyTo: 'scripts/**'

PrintFarmer Scripts

This directory contains all build, deployment, local development, and maintenance automation for PrintFarmer. Scripts are not part of the src/ build system — they run from the repo root or scripts/ itself.

Directory Layout

Tech Stack

• Shell: Bash with set -euo pipefail on every script. Follow shell.instructions.md.
• Python 3: Used for YAML manipulation (ruamel.yaml) and OrcaSlicer profile extraction. Must have ruamel.yaml installed — missing it causes silent deploy failures.
• Node.js (CJS): check-path-casing.js, validate-openapi.js, restore-orcaslicer-assets.js — small utility scripts, no separate package.json.
• PowerShell: compose-generator.ps1, deploy-docker.ps1, bootstrap-windows.ps1 for Windows support.
• C# scripts: test_perimeters_regex.csx, test_probe.csx — run with dotnet script.
• envsubst: Used in compose-generator.sh to inject container-versions.conf values into compose templates.

Conventions

• Always source shared libraries at the top of new shell scripts:

  SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
  source "$SCRIPT_DIR/common-utils.sh"

• Logging: Use log_info, log_success, log_warn, log_error, log_header from common-utils.sh — never raw echo for status messages. Aliases print_info/print_success/print_warning/print_error also exist for backward compatibility.
• Version tags: Always read from scripts/docker/container-versions.conf via source. Never hardcode image tags.
• Library-only scripts (docker-utils.sh, lib_verify_worker.sh, common-utils.sh) must guard against direct execution and exit with an error if run as $0.
• Compose templates are in scripts/docker/compose-templates/. The generated docker-compose.yml at the repo root is disposable — always edit the templates.
• Worker verify scripts (verify-*.sh) must define required variables (WORKER_NAME, ENV_PREFIX, etc.) before sourcing lib_verify_worker.sh.

Key Commands

# Local development
./scripts/pf-dev.sh bootstrap   # Restore dotnet + npm deps
./scripts/pf-dev.sh start       # Start API + React in background
./scripts/pf-dev.sh stop        # Stop dev processes
./scripts/pf-dev.sh test        # Run all tests

# Docker deployment
./scripts/deploy-docker.sh                          # Interactive
./scripts/deploy-docker.sh --non-interactive --auto-admin --auto-admin-password=Secret1!

# Compose generation (called by deploy-docker.sh automatically)
./scripts/docker/compose-generator.sh

# Version bump
./scripts/bump-version.sh patch