Skip to content

Commit

Permalink
Add step by step process for updating API
Browse files Browse the repository at this point in the history
  • Loading branch information
wkozyra95 committed Dec 19, 2024
1 parent 4131359 commit 92104aa
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -186,3 +186,16 @@ pnpm run dev
Open `localhost:5173` in the browser

If Rust code changes you need to rebuild WASM with `pnpm run build-wasm`.

## Process for introducing API changes

Everything in the same PR.

- Update Rust code.
- Run `cargo run --bin generate_from_types` in **`./generate`** that will generate **`./schemas/scene.schema.json`**.
- Run `pnpm run generate-types` in **`./ts`** that will generate **`./ts/live-compositor/src/api.generated.ts`**.
- Update TypeScript code to support new changes.
- Update CHANGELOG

> To avoid problems with forgetting about adding some changes to TS, everything that shows up in PR diff for
`./ts/live-compositor/src/api.generated.ts` should be addressed in the PR that regenerated those types.

0 comments on commit 92104aa

Please sign in to comment.