Skip to content

Commit

Permalink
update example channel doc
Browse files Browse the repository at this point in the history
  • Loading branch information
teh-cmc committed Nov 27, 2024
1 parent 18189a4 commit 1065438
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,5 +47,9 @@ If you want to run the example on CI and include it in the in-viewer example pag
add a `channel` entry to its README frontmatter. The available channels right now are:
- `main` for simple/fast examples built on each merge to `main`
- `nightly` for heavier examples built once per day
- `release` for very heavy examples built once per release

These channels are defined in: https://github.com/rerun-io/rerun/blob/18189a436271d58efe55a9c58fb3ff4d29098fd2/crates/build/re_dev_tools/src/build_examples/example.rs#L150-L158


If `channel` is missing, the example is never built on CI.

0 comments on commit 1065438

Please sign in to comment.