AGENTS.md

Scripts

Scope: scripts/**. Also follow root instructions.

Shell Scripts

• New scripts must use named --kebab-case parameters with short aliases, not positional parameters
• Start scripts with set -euo pipefail
• Declare defaults before usage() and validate required parameters after parsing
• Document every parameter in usage()
• Source ci-utils.sh for CI logging; use log_info for routine output and reserve log_notice for intentional GitHub annotations
• Extract repeated logic into local functions; source a shared library for logic used by multiple scripts
• Keep validate-xcframework.sh product-agnostic; invoke product-specific checks from the caller
• Use assemble-xcframework.sh for XCArchive, standalone-framework, and static-library assembly
• Avoid complex heredocs and move substantial logic into an appropriate standalone script
• Follow scripts/sentry-xcodebuild.sh as the named-parameter reference

Template

#!/bin/bash
set -euo pipefail

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

PARAM_ONE=""
PARAM_TWO="default-value"

usage() {
    log_info "Usage: $0"
    log_info "  -p, --param-one <value>    Description of param one (required)"
    log_info "  -t, --param-two <value>    Description of param two (default: default-value)"
    exit 1
}

while [[ $# -gt 0 ]]; do
    case $1 in
        -p|--param-one) PARAM_ONE="$2"; shift 2 ;;
        -t|--param-two) PARAM_TWO="$2"; shift 2 ;;
        *) usage ;;
    esac
done

if [ -z "$PARAM_ONE" ]; then
    log_error "Error: --param-one is required"
    usage
fi

Legacy Scripts

• Do not migrate unrelated positional arguments while making a focused change
• Migrate a legacy script to named parameters only when required by the requested change
• Keep scripts/bump.sh positional: Craft requires its two positional version arguments