Skip to content

Commit 915705e

Browse files
committed
docs(app-management): add instructions for preview testing with menu and events
1 parent d6d85a7 commit 915705e

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

docs/app-management.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,28 @@ Verify:
5959
- `bkper app status` shows the deployed version
6060
- URLs in `bkper.yaml` match the deployed domain (`https://{appId}.bkper.app`)
6161

62+
#### Preview testing with menu and events
63+
64+
To test a preview deployment from the Bkper UI, keep production URLs unchanged and point the development URLs to the preview Worker:
65+
66+
```yaml
67+
menuUrl: https://{appId}.bkper.app?bookId=${book.id}
68+
menuUrlDev: https://{appId}-preview.bkper.app?bookId=${book.id}
69+
70+
webhookUrl: https://{appId}.bkper.app/events
71+
webhookUrlDev: https://{appId}-preview.bkper.app/events
72+
```
73+
74+
Then build, sync metadata, and deploy to preview:
75+
76+
```bash
77+
npm run build
78+
bkper app sync
79+
bkper app deploy --preview
80+
```
81+
82+
Bkper uses `menuUrlDev` for developer menu access and `webhookUrlDev` for development-mode events. If `bkper app dev` runs later, it may replace `webhookUrlDev` with a local tunnel URL; set it back to the preview URL and run `bkper app sync` before testing preview again.
83+
6284
### 5. Validate
6385

6486
```bash

0 commit comments

Comments
 (0)