chore: tidy local debug scripts
This commit is contained in:
@@ -23,7 +23,7 @@ Use the managed local debug scripts for browser-facing verification. Do not star
|
||||
- Default platform API: `http://127.0.0.1:18080`.
|
||||
- Default platform_web: `http://127.0.0.1:5173`.
|
||||
- Default local debug root: `.local-debug/`.
|
||||
- Restart with `scripts/local-debug-stop.sh` followed by `scripts/local-debug-start.sh`.
|
||||
- Restart with `scripts/dev-stop.sh` followed by `scripts/dev-start.sh`.
|
||||
- Use `LOCAL_DEBUG_PLATFORM_PORT`, `LOCAL_DEBUG_WEB_PORT`, and `LOCAL_DEBUG_ROOT` only when a task explicitly needs an isolated stack.
|
||||
- When debugging an already-running local page, prefer the current `5173`/`18080` stack and inspect `.local-debug/logs/` before starting anything else.
|
||||
|
||||
@@ -31,7 +31,7 @@ Use the managed local debug scripts for browser-facing verification. Do not star
|
||||
|
||||
```bash
|
||||
git clone git@git.npc0.com:admin343/run.git run # once, if the ignored local checkout is missing
|
||||
scripts/local-debug-start.sh
|
||||
scripts/dev-start.sh
|
||||
```
|
||||
|
||||
The script prints the resolved platform URL, platform_web URL, log files, and the exact local account for browser login:
|
||||
@@ -42,12 +42,12 @@ The script prints the resolved platform URL, platform_web URL, log files, and th
|
||||
Useful defaults can be overridden before running the script:
|
||||
|
||||
```bash
|
||||
LOCAL_DEBUG_PLATFORM_PORT=18081 LOCAL_DEBUG_WEB_PORT=5174 scripts/local-debug-start.sh
|
||||
LOCAL_DEBUG_PLATFORM_PORT=18081 LOCAL_DEBUG_WEB_PORT=5174 scripts/dev-start.sh
|
||||
```
|
||||
|
||||
## Environment
|
||||
|
||||
The scripts source `scripts/local-debug-env.sh`.
|
||||
The public commands use shared local debug helpers under `scripts/local-debug/`.
|
||||
|
||||
Key platform variables:
|
||||
|
||||
@@ -85,13 +85,13 @@ Key frontend variables:
|
||||
Start the stack, then run:
|
||||
|
||||
```bash
|
||||
scripts/local-debug-smoke.sh
|
||||
scripts/dev-smoke.sh
|
||||
```
|
||||
|
||||
For one-command verification in environments that clean up background processes when a command returns, run:
|
||||
|
||||
```bash
|
||||
LOCAL_DEBUG_SELF_START=true scripts/local-debug-smoke.sh
|
||||
LOCAL_DEBUG_SELF_START=true scripts/dev-smoke.sh
|
||||
```
|
||||
|
||||
The smoke command verifies:
|
||||
@@ -119,7 +119,7 @@ Run the automated browser acceptance suite when you need repeatable proof for th
|
||||
LOCAL_DEBUG_PLATFORM_PORT=18189 LOCAL_DEBUG_WEB_PORT=5183 LOCAL_DEBUG_ROOT=/private/tmp/browser-local-debug-acceptance scripts/browser-acceptance.sh
|
||||
```
|
||||
|
||||
By default the command safely resets the configured local debug root, starts platform, run worker, and platform_web, runs `scripts/local-debug-smoke.sh`, verifies browser-facing route contracts, and cleans up the self-started stack. Set `BROWSER_ACCEPTANCE_SELF_START=false` to run against an already-started local debug stack.
|
||||
By default the command safely resets the configured local debug root, starts platform, run worker, and platform_web, runs `scripts/dev-smoke.sh`, verifies browser-facing route contracts, and cleans up the self-started stack. Set `BROWSER_ACCEPTANCE_SELF_START=false` to run against an already-started local debug stack.
|
||||
|
||||
Acceptance evidence is written to:
|
||||
|
||||
@@ -131,7 +131,7 @@ The evidence records stack URLs, the smoke seed evidence directory, first-party
|
||||
|
||||
## Browser Walkthrough
|
||||
|
||||
After `scripts/local-debug-smoke.sh` passes, open platform_web:
|
||||
After `scripts/dev-smoke.sh` passes, open platform_web:
|
||||
|
||||
```text
|
||||
http://127.0.0.1:5173
|
||||
@@ -154,13 +154,13 @@ Acceptance requires logical IDs, platform routes, job refs, log refs, artifact r
|
||||
## Stop
|
||||
|
||||
```bash
|
||||
scripts/local-debug-stop.sh
|
||||
scripts/dev-stop.sh
|
||||
```
|
||||
|
||||
## Reset
|
||||
|
||||
```bash
|
||||
scripts/local-debug-reset.sh
|
||||
scripts/dev-reset.sh
|
||||
```
|
||||
|
||||
Reset stops the local debug processes and deletes only the documented local debug root. By default that root is:
|
||||
@@ -181,7 +181,7 @@ The start script wraps these commands with the local debug environment:
|
||||
|
||||
```bash
|
||||
(cd platform && go run ./cmd/platform)
|
||||
source scripts/local-debug-env.sh
|
||||
source scripts/local-debug/env.sh
|
||||
local_debug_build_bootstrap_run
|
||||
"$RUN_BOOTSTRAP_BIN"
|
||||
npm --prefix platform_web run dev -- --port 5173
|
||||
|
||||
Reference in New Issue
Block a user