Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tracking issue: Revamp of our example building infrastructure #3212

Closed
4 tasks done
abey79 opened this issue Sep 5, 2023 · 3 comments
Closed
4 tasks done

Tracking issue: Revamp of our example building infrastructure #3212

abey79 opened this issue Sep 5, 2023 · 3 comments
Labels
🧑‍💻 dev experience developer experience (excluding CI) 🎄 tracking issue issue that tracks a bunch of subissues
Milestone

Comments

@abey79
Copy link
Member

abey79 commented Sep 5, 2023


The in-app example page (#3191) relies on pre-build RRD for its example. These RRD must be up-to-date for the dev builds, and version-specific for the public release. These RRD are also costly to build, which means we currently have only 7 examples covered. This figure must be increased.

@teh-cmc
Copy link
Member

teh-cmc commented Sep 5, 2023

Relevant: #3204 introduces the _RERUN_TEST_FORCE_SAVE=<filepath.rrd> environment variable, that will force any RecordingStream to write to a specified file on disk, irrelevant of how it was set up (connect(), spawn(), etc...).

@emilk
Copy link
Member

emilk commented Sep 5, 2023

Let's try to get this in before 0.9, but start with just the minimal set of examples.

abey79 added a commit that referenced this issue Sep 6, 2023
### What

Add Example page to the Welcome Screen.


Fixes #3096 

<img width="1366" alt="image"
src="https://github.com/rerun-io/rerun/assets/49431240/bbe2e84e-9ade-4da8-b095-d7b0f396c26f">

### TODO

- [x] fix layout issues
- [x] display tags
- [x] have dedicated, short copy for the description: #3201

### Not included in this PR

- **WARNING**: here, we bake in a manifest with hard-coded links to RRDs
that were generated within this PR. This will lead to issue down the
line, when the RRD format changes.
  - #3212
  - #3213
- download updated manifest
  -  #3190 
- load thumbnail from the web
  - emilk/egui#3291
- provide feedback while downloading a RRD
  - #3192

### Checklist
* [x] I have read and agree to [Contributor
Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and
the [Code of
Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md)
* [x] I've included a screenshot or gif (if applicable)
* [x] I have tested [demo.rerun.io](https://demo.rerun.io/pr/3191) (if
applicable)

- [PR Build Summary](https://build.rerun.io/pr/3191)
- [Docs
preview](https://rerun.io/preview/3be107e4cc6aa6758a3f22c27a79233b33f2ea6b/docs)
<!--DOCS-PREVIEW-->
- [Examples
preview](https://rerun.io/preview/3be107e4cc6aa6758a3f22c27a79233b33f2ea6b/examples)
<!--EXAMPLES-PREVIEW-->
- [Recent benchmark results](https://ref.rerun.io/dev/bench/)
- [Wasm size tracking](https://ref.rerun.io/dev/sizes/)

---------

Co-authored-by: Emil Ernerfeldt <emil.ernerfeldt@gmail.com>
@emilk
Copy link
Member

emilk commented Sep 11, 2023

The viewer include_str!:s crates/re_viewer/data/examples_manifest.json which in turn points to .rrd urls at a specific commit. Currently we need to update examples_manifest.json manually.

For 0.9 we could just update it manually to point to .rrd's we've updated specifically for the 0.9 release.

…or we figure out a proper fix for this.

@jprochazk jprochazk changed the title Revamp of our example building infrastructure Tracking issue: Revamp of our example building infrastructure Sep 15, 2023
@jprochazk jprochazk added the 🎄 tracking issue issue that tracks a bunch of subissues label Sep 15, 2023
jprochazk added a commit that referenced this issue Sep 18, 2023
### What

Part of #3212

- Check that examples with a `thumbnail` have `thumbnail_dimensions` too
- Add `scripts/ci/thumbnails.py` script for checking/updating
`thumbnail_dimensions`
- Add `build.rs` to `re_viewer`
  - Keeps `re_viewer/data/examples_manifest.json` up to date
  - The file is committed, and is only updated in rerun workspace/CI
  - URLs point to:
    - `version/nightly` on `main`/local builds
    - `version/x.y.z` on release branches
    - `commit/{short_hash}` on PRs

### Checklist
* [x] I have read and agree to [Contributor
Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and
the [Code of
Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md)
* [x] I've included a screenshot or gif (if applicable)
* [x] I have tested [demo.rerun.io](https://demo.rerun.io/pr/3332) (if
applicable)

- [PR Build Summary](https://build.rerun.io/pr/3332)
- [Docs
preview](https://rerun.io/preview/1ba564f5afd6709dbe50ff411ba563b1d668caea/docs)
<!--DOCS-PREVIEW-->
- [Examples
preview](https://rerun.io/preview/1ba564f5afd6709dbe50ff411ba563b1d668caea/examples)
<!--EXAMPLES-PREVIEW-->
- [Recent benchmark results](https://ref.rerun.io/dev/bench/)
- [Wasm size tracking](https://ref.rerun.io/dev/sizes/)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🧑‍💻 dev experience developer experience (excluding CI) 🎄 tracking issue issue that tracks a bunch of subissues
Projects
None yet
Development

No branches or pull requests

4 participants