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
{{ message }}
Repository navigation
Commit 5632356
Browse filesBrowse the repository at this point in the historyBrowse files
docs: show agents where Studio edits go and how tests build, and let docs skip captures (#4936)
* fix(ci): let markdown-only changes under studio and player skip the captures check
* docs: map the Studio edit path, the edit accuracy bench and test setup for agents
* docs: name the Studio captures rule and the local comment checks
* docs: point the Studio gate notes at the scripts that own the rules
* docs: correct the Studio save paths and add the producer stage map
* docs: name where producer sizes workers and which captures encode inline
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -97,6 +97,8 @@ Reviewers judge rules 2 to 5 and 8. The `Comments` check (`scripts/check-comment
97
97
98
98
Only comment blocks holding a line your PR added can fail the citation and block rules, and the TODO and URL rules grade only the lines your PR added. Broken citations elsewhere in a file you touched are printed as warnings, and fixing one while you are there is welcome. To grade files by hand, pass their paths: `node scripts/check-comment-citations.mjs path/to/file.ts`.
99
99
100
+
Run both checks before pushing: `node scripts/check-comment-citations.mjs` and `node scripts/comment-ratchet.mjs` grade your branch against its merge-base with `origin/main` (set `COMMENT_CHECK_BASE` to compare with another base). The pre-commit hooks run neither.
101
+
100
102
## Adding Registry Items (Blocks & Components)
101
103
102
104
The registry at `registry/` contains reusable items installable via `hyperframes add <name>`. Each item lives in its own directory under `registry/blocks/` or `registry/components/`.
@@ -198,14 +200,12 @@ All packages use **fixed versioning** — every release bumps all packages to th
198
200
### Stable releases
199
201
200
202
```bash
201
-
bun run release:prepare 0.2.0 # drafts changelog if needed, then creates the release commit/tag after review
202
-
git push origin main# push the release commit
203
-
git push origin v0.2.0 # push the tag → triggers the publish workflow
203
+
git switch -c release/v0.2.0 origin/main
204
+
bun run release:prepare 0.2.0# drafts release notes and stops for review; rerun after editing them
205
+
git push origin release/v0.2.0 # push the branch, not the local tag
204
206
```
205
207
206
-
> Push the **specific tag**, not `git push --tags` — the latter pushes every local tag and the whole push is rejected if any one already exists on the remote.
207
-
208
-
The `release:prepare` script drafts missing release notes on the first run and stops for manual review. After the generated TODO summary is rewritten, rerun the same command; it delegates to `set-version`, which creates a `chore: release v<version>` commit and a `v<version>` git tag. Pushing the tag triggers CI to publish all packages to npm and create a GitHub Release.
208
+
Open a PR from `release/v0.2.0` to `main`. When it merges, the publish workflow tags the merge commit, publishes every package to npm and creates the GitHub Release. Pushing a stable tag by hand publishes nothing: the workflow only accepts pre-release tags. The full procedure, including recovery from a failed publish, is in [docs/contributing/changelog-process.mdx](docs/contributing/changelog-process.mdx).
209
209
210
210
`set-version` also refuses to tag if a **higher** semver tag already exists (a stale higher tag would hijack tag-sorting installers like `npx skills`). Delete the stray tag (`git tag -d <tag> && git push origin :refs/tags/<tag>`) or, only if intentional, pass `--skip-monotonicity-check`.
Copy file name to clipboardExpand all lines: packages/producer/README.md
+20Lines changed: 20 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -184,6 +184,26 @@ The activity functions plus their result types are also re-exported from `@hyper
184
184
4.**Mix** — extracts `<audio>` elements and mixes them into the final video. For `png-sequence`, audio is written as an `audio.aac` sidecar.
185
185
5.**Finalize** — applies faststart for streaming-friendly MP4 (no-op for WebM, MOV, and `png-sequence`). For `hls`, stream-copies the encode into playlists and MPEG-TS segments instead.
186
186
187
+
### Where each step lives
188
+
189
+
`executeRenderJob` in `src/services/renderOrchestrator.ts` runs the stages in
-`src/services/render/captureCost.ts` sizes the worker count
194
+
(`runCaptureCalibration`, then `resolveRenderWorkerCount`)
195
+
-`createCapturePlan` in `src/services/render/capturePlan.ts` picks the capture
196
+
kind: streaming, disk, segmented or HDR layered
197
+
- capture: `captureStreamingStage.ts`, `captureSegmentedStage.ts` and
198
+
`captureHdrStage.ts` encode as they capture; disk capture (`captureStage.ts`)
199
+
encodes afterwards in `encodeStage.ts`
200
+
-`assembleStage.ts`, except for PNG sequences and GIF, which are written
201
+
directly
202
+
203
+
The job's `producerConfig` is used when present; otherwise `resolveConfig` in
204
+
`packages/engine/src/config.ts` builds it. Capture, encoding and browser
205
+
primitives are engine services (see `packages/engine/README.md`).
206
+
187
207
## Documentation
188
208
189
209
Full documentation: [hyperframes.heygen.com/packages/producer](https://hyperframes.heygen.com/packages/producer)
0 commit comments