Skip to content

Commit bfd59cf

Browse files
Add preview lifecycle flow diagram
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
1 parent 5674696 commit bfd59cf

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

.github/PR-PREVIEW.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,22 @@ This repository publishes docs previews for pull requests under:
1515
- removes `previews/pr-<number>/` by pushing directly to `gh-pages` as the Scribbler app,
1616
- deletes all preview deployments and the preview environment.
1717

18+
## Flow diagram
19+
20+
```mermaid
21+
flowchart TD
22+
A[Contributor opens or updates PR to main] --> B[Docs workflow builds preview site]
23+
B --> C[Scribbler app token pushes preview files to gh-pages under previews/pr-N]
24+
C --> D[Workflow sets environment pr-preview-N with preview URL]
25+
D --> E[Workflow comments on PR with preview link]
26+
E --> F[Contributor iterates on PR]
27+
F --> B
28+
G[PR closed: merged or abandoned] --> H[Cleanup job runs]
29+
H --> I[Scribbler app token removes previews/pr-N from gh-pages]
30+
I --> J[Workflow deletes preview deployments + environment]
31+
J --> K[Workflow updates PR comment: preview removed]
32+
```
33+
1834
## Required repository configuration
1935

2036
1. Ensure `gh-pages` branch exists.

0 commit comments

Comments
 (0)