Remove trail finding examples and docs · Entire

Remove trail finding examples and docs

Sessions

Changes

3

24 unmodified lines

25
26
27
28
28
29
30
5 unmodified lines

36
37
38
40
39
40
41

24 unmodified lines

├── agents/       # Agent abstraction (Agent interface, tmux sessions, concurrency gates)
├── bootstrap/    # CI pre-test setup (auth config, warmup)
├── entire/       # `entire` CLI wrapper (enable, rewind, etc.)
├── examples/     # Manual golden-path scripts, not run by CI
├── exploratory/  # Experimental tests, not run by CI
├── tests/        # Blessed test files (run by CI)
└── testutil/     # Repo setup, assertions, artifact capture
5 unmodified lines

- All operations go through `RepoState` (`s.RunPrompt`, `s.Git`) so they're logged to `console.log`.
- Use the `entire` package for CLI interactions, not raw `exec.Command`.
- Skip tests pending CLI fixes with `t.Skip("ENT-XXX: reason")`.
- Put manual, service-backed golden paths under `e2e/examples/`; they are documentation and release-verification scripts, not CI tests.

## Adding a New Agent

E2E examples

Manual end-to-end examples for workflows that touch real Entire services.

These are not run by CI. They are intended as copy/pasteable golden paths for release verification and debugging. Run them from a git repository with an origin remote that resolves to a repo with trails, and authenticate first with entire login.

Trail finding golden path

./e2e/examples/trail-finding-golden-path.sh

Optional environment variables:

The script exercises the intended user/agent path:

  1. discover trails with entire trail list --status any
  2. show finding dashboard for current branch/default target
  3. create a trail-scoped finding with a client_id
  4. list findings
  5. show the created finding
  6. resolve the created finding

# Golden path for manual trail-finding CLI verification.
# Run from a git repo with an origin remote and an authenticated Entire CLI.

ENTIRE_BIN="${ENTIRE_BIN:-entire}"
TARGET_SELECTOR="${ENTIRE_TRAIL_FINDING_SELECTOR:-${ENTIRE_TRAIL_REVIEW_SELECTOR:-}}"
FINDING_FILE="${ENTIRE_TRAIL_FINDING_FILE:-${ENTIRE_TRAIL_REVIEW_FILE:-README.md}}"
FINDING_LINE="${ENTIRE_TRAIL_FINDING_LINE:-${ENTIRE_TRAIL_REVIEW_LINE:-1}}"
CLIENT_ID="trail-finding-e2e:$(date +%s):$$"

target_args=()
if [[ -n "$TARGET_SELECTOR" ]]; then
  target_args+=("$TARGET_SELECTOR")
fi

run() {
  printf '\n$ %q' "$ENTIRE_BIN"
  printf ' %q' "$@"
  printf '\n'
  "$ENTIRE_BIN" "$@"
}

need() {
  if ! command -v "$1" >/dev/null 2>&1; then
    echo "missing required command: $1" >&2
    exit 1
  fi
}

need "$ENTIRE_BIN"
need jq

echo "Trail finding golden path"
echo "Target: ${TARGET_SELECTOR:-current branch trail}"
echo "Finding location: ${FINDING_FILE}:${FINDING_LINE}"

run trail list --status any --limit 10
run trail finding "${target_args[@]}"

printf '\n$ %q' "$ENTIRE_BIN"
printf ' %q' trail finding add "${target_args[@]}" \
  --json \
  --title "E2E finding" \
  --body "Golden-path finding created by the trail finding E2E example." \
  --severity medium \
  --confidence 0.9 \
  --file "$FINDING_FILE" \
  --line "$FINDING_LINE" \
  --client-id "$CLIENT_ID"
printf '\n'

finding_json="$($ENTIRE_BIN trail finding add "${target_args[@]}" \
  --json \
  --title "E2E finding" \
  --body "Golden-path finding created by the trail finding E2E example." \
  --severity medium \
  --confidence 0.9 \
  --file "$FINDING_FILE" \
  --line "$FINDING_LINE" \
  --client-id "$CLIENT_ID")"

printf '%s\n' "$finding_json" | jq .
finding_id=$(printf '%s\n' "$finding_json" | jq -r '.id')
if [[ -z "$finding_id" || "$finding_id" == "null" ]]; then
  echo "create finding response did not include .id" >&2
  exit 1
fi

run trail finding list "${target_args[@]}" --status any --include-dismissed
run trail finding show "${target_args[@]}" "$finding_id"
run trail finding resolve "${target_args[@]}" "$finding_id" -m "resolved by trail finding golden-path e2e example"
run trail finding list "${target_args[@]}" --status any --include-dismissed

echo
printf 'Golden path complete. Created and resolved finding: %s\n' "$finding_id"