Skip to content

The open-source app everyone uses to manage agents at work

feat: add committed-ref onboarding smoke script

Dottaa47ea343ba99
diff --git a/doc/RELEASING.md b/doc/RELEASING.md
index 8ffd80fdf2..9ca74d1114 100644
--- a/doc/RELEASING.md
+++ b/doc/RELEASING.md
@@ -128,6 +128,16 @@ If you want to exercise onboarding from a fresh local checkout rather than npm,
That is not a required release step every time, but it is a useful higher-confidence check when onboarding is the main risk area or when you need to verify what the current codebase does before publishing.
+If you want to exercise onboarding from the current committed ref in your local repo, use:
+
+```bash
+./scripts/clean-onboard-ref.sh
+PAPERCLIP_PORT=3234 ./scripts/clean-onboard-ref.sh
+./scripts/clean-onboard-ref.sh HEAD
+```
+
+This uses the current committed `HEAD` in a detached temp worktree. It does **not** include uncommitted local edits.
+
### GitHub Actions release
There is also a manual workflow at [`.github/workflows/release.yml`](../.github/workflows/release.yml). It is designed for npm trusted publishing via GitHub OIDC instead of long-lived npm tokens.
@@ -344,6 +354,7 @@ If you want to smoke onboarding from the current codebase rather than npm, run:
```bash
./scripts/clean-onboard-git.sh
+./scripts/clean-onboard-ref.sh
```
Minimum checks:
diff --git a/scripts/clean-onboard-ref.sh b/scripts/clean-onboard-ref.sh
new file mode 100755
index 0000000000..a42c5ea4ae
--- /dev/null
+++ b/scripts/clean-onboard-ref.sh
@@ -0,0 +1,86 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+REPO_ROOT="$(cd "$(dirname "$0")/.." && pwd)"
+TARGET_REF="${1:-HEAD}"
+
+usage() {
+ cat <<'EOF'
+Usage:
+ ./scripts/clean-onboard-ref.sh [git-ref]
+
+Examples:
+ ./scripts/clean-onboard-ref.sh
+ ./scripts/clean-onboard-ref.sh HEAD
+ ./scripts/clean-onboard-ref.sh v0.2.7
+
+Environment overrides:
+ KEEP_TEMP=1 Keep the temp directory and detached worktree for debugging
+ PC_TEST_ROOT=/tmp/custom Base temp directory to use
+ PC_DATA=/tmp/data Paperclip data dir to use
+ PAPERCLIP_HOST=127.0.0.1 Host passed to the onboarded server
+ PAPERCLIP_PORT=3232 Port passed to the onboarded server
+
+Notes:
+ - Defaults to the current committed ref (HEAD), not uncommitted local edits.
+ - Creates an isolated temp HOME, npm cache, data dir, and detached git worktree.
+EOF
+}
+
+if [ $# -gt 1 ]; then
+ usage
+ exit 1
+fi
+
+if [ $# -eq 1 ] && [[ "$1" =~ ^(-h|--help)$ ]]; then
+ usage
+ exit 0
+fi
+
+TARGET_COMMIT="$(git -C "$REPO_ROOT" rev-parse --verify "${TARGET_REF}^{commit}")"
+
+export KEEP_TEMP="${KEEP_TEMP:-0}"
+export PC_TEST_ROOT="${PC_TEST_ROOT:-$(mktemp -d /tmp/paperclip-clean-ref.XXXXXX)}"
+export PC_HOME="${PC_HOME:-$PC_TEST_ROOT/home}"
+export PC_CACHE="${PC_CACHE:-$PC_TEST_ROOT/npm-cache}"
+export PC_DATA="${PC_DATA:-$PC_TEST_ROOT/paperclip-data}"
+export PC_REPO="${PC_REPO:-$PC_TEST_ROOT/repo}"
+export PAPERCLIP_HOST="${PAPERCLIP_HOST:-127.0.0.1}"
+export PAPERCLIP_PORT="${PAPERCLIP_PORT:-3100}"
+export PAPERCLIP_OPEN_ON_LISTEN="${PAPERCLIP_OPEN_ON_LISTEN:-false}"
+
+cleanup() {
+ if [ "$KEEP_TEMP" = "1" ]; then
+ return
+ fi
+
+ git -C "$REPO_ROOT" worktree remove --force "$PC_REPO" >/dev/null 2>&1 || true
+ rm -rf "$PC_TEST_ROOT"
+}
+
+trap cleanup EXIT
+
+mkdir -p "$PC_HOME" "$PC_CACHE" "$PC_DATA"
+
+echo "TARGET_REF: $TARGET_REF"
+echo "TARGET_COMMIT: $TARGET_COMMIT"
+echo "PC_TEST_ROOT: $PC_TEST_ROOT"
+echo "PC_HOME: $PC_HOME"
+echo "PC_DATA: $PC_DATA"
+echo "PC_REPO: $PC_REPO"
+echo "PAPERCLIP_HOST: $PAPERCLIP_HOST"
+echo "PAPERCLIP_PORT: $PAPERCLIP_PORT"
+
+git -C "$REPO_ROOT" worktree add --detach "$PC_REPO" "$TARGET_COMMIT"
+
+cd "$PC_REPO"
+pnpm install
+
+env \
+ HOME="$PC_HOME" \
+ npm_config_cache="$PC_CACHE" \
+ npm_config_userconfig="$PC_HOME/.npmrc" \
+ HOST="$PAPERCLIP_HOST" \
+ PORT="$PAPERCLIP_PORT" \
+ PAPERCLIP_OPEN_ON_LISTEN="$PAPERCLIP_OPEN_ON_LISTEN" \
+ pnpm paperclipai onboard --yes --data-dir "$PC_DATA"