You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
-34Lines changed: 0 additions & 34 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -159,40 +159,6 @@ UPDATE_SNAPSHOTS=1 just snapshot-test create
159
159
160
160
The full case/step/interaction reference (including the `vpt` helper tool and milestone conventions for interactive tests) lives in `crates/vp_cli_snapshots/tests/cli_snapshots/README.md`; the design rationale is in `rfcs/interactive-snapshot-tests.md`.
161
161
162
-
## Documentation previews from forks
163
-
164
-
Documentation PRs from forks receive a Cloudflare preview from the
165
-
`Build Docs Fork Preview` and `Deploy Docs Fork Preview` workflows. The build
166
-
runs without deployment credentials. The deployment workflow uses code from
167
-
the default branch and uploads the static build artifact to `viteplus-dev`.
168
-
It checks the source repository, branch, and current PR commit before upload.
169
-
The PR alias stays the same across updates to a PR.
170
-
171
-
Repository maintainers must configure the GitHub environment `docs-preview`:
172
-
173
-
- Set the environment variable `CLOUDFLARE_ACCOUNT_ID` to the account that owns
174
-
`viteplus-dev`.
175
-
- Add the environment secret `CLOUDFLARE_API_TOKEN` with permission to upload
176
-
Worker versions to that account. Use the narrowest available token scope.
177
-
- Enable Preview URLs for `viteplus-dev` in Cloudflare. The expected Workers
178
-
subdomain is `voidzero-docs.workers.dev`.
179
-
180
-
The deployment workflow must be on `main` before GitHub can trigger it through
181
-
`workflow_run`. After setup, push a documentation change to an open fork PR.
182
-
GitHub may require approval for the contributor's first workflow run. A
183
-
successful deployment adds or updates a comment on the original PR. The comment
184
-
links to a fixed Worker version for the stated commit. It also includes the PR
185
-
alias, such as `https://pr-2684-viteplus-dev.voidzero-docs.workers.dev`, which can
186
-
point to a later upload. `wrangler versions upload` does not promote the version
187
-
to production.
188
-
189
-
Same-repository PRs continue to use the existing preview integrations. To test
Prioritize stacked pull requests when your work splits into reviewable layers, for example a refactor PR with the feature PR that depends on it stacked on top. Reviewers handle a stack of small PRs faster than one large PR, and each layer merges on its own.
0 commit comments