Skip to content

Commit 5a756a8

Browse files
authored
docs(handbook): add hobby deployment preview documentation (#14120)
1 parent 09df117 commit 5a756a8

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

contents/handbook/engineering/development-process.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -217,6 +217,26 @@ git push origin --force <your branch>
217217

218218
> Why does this work? As we mentioned earlier, our CI runs `test-runner.ts` on every push, so we don't really care if these images are conflicted as they are regenerated after you push to your branch.
219219
220+
### Deployed Preview
221+
222+
You can spin up a real deployed PostHog instance to test your branch by adding the `hobby-preview` label to your PR. This uses the hobby (Docker Compose) self-hosted setup under the hood.
223+
224+
**How it works:**
225+
226+
1. Add the `hobby-preview` label to your PR
227+
2. CI creates a DigitalOcean droplet and deploys PostHog with your branch
228+
3. A comment is posted to the PR with the preview URL (e.g., `https://hobby-pr-12345.posthog.dev`)
229+
4. The droplet persists across commits so you can iterate
230+
5. Remove the label or close the PR to clean up the droplet
231+
232+
**When to use it:**
233+
234+
- Testing changes in a real deployed environment
235+
- Manual QA before merging
236+
- Verifying Docker Compose or deployment script changes
237+
238+
The workflow also runs a smoke test (health check) automatically on PRs that touch deployment-related files.
239+
220240
## Reviewing code
221241
222242
When we review a PR, we'll look at the following things:

0 commit comments

Comments
 (0)