- Notifications
You must be signed in to change notification settings - Fork408
Allow building examples locally using helper script and zola config#2275
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
base:main
Are you sure you want to change the base?
Uh oh!
There was an error while loading.Please reload this page.
Conversation
| @@ -0,0 +1,34 @@ | |||
| # Zola config for compiling examples locally | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
IMO we shouldn't maintain a separate nearly identical copy of this file just for this purpose. I would move the local versions ofwasm_webgl2_base_url to comments inconfig.toml.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Personally, i'd love to not need either, but Zola is limited in this regard. Maybe comments can work, but my goal was that there won't be a need to edit a git tracked file for at least the basic usecases.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Was just working with these changes myself to help troubleshoot another issue, and having the config predefined absolutely helped smooth out the process.
I don't think it's particularly uncommon to have a local config file for this sort of thing, and it doesn't look like Zola supports extending configs.
How often do these config files change? Will having an additional config file meaningfully increase maintenance costs?
| CARGO_PROFILE_RELEASE_OPT_LEVEL='z' CARGO_PROFILE_RELEASE_DEBUG="true" cargo run -p example-showcase -- --per-page$1 --page 0 build-wasm-examples --content-folder ../../static/assets/examples/wasm_webgl2 --api webgl2 --website-hacks | ||
| CARGO_PROFILE_RELEASE_OPT_LEVEL='z' CARGO_PROFILE_RELEASE_DEBUG="true" cargo run -p example-showcase -- --per-page$1 --page 0 build-wasm-examples --content-folder ../../static/assets/examples/wasm_webgpu --api webgpu |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
IMO, it's a bit unfortunate to repeat these invocations here in this new script. Would prefer thatgenerate_wasm_example.sh handle the limiting.
Also, I think I or someone may have added a--debug option toexample-showcase.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
but generate_wasm_examples.sh never callsexample-showcase build-wasm-example? only the CI yaml has another version of this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Also, I think I or someone may have added a --debug option to example-showcase.
Just tried this: the option does exist, but its not implemented for thebuild-wasm-example command and silently gets ignored. Its only applied for therun command as far as I can tell:https://github.com/bevyengine/bevy/blob/0b8844a3a060b2a5b7c3302bd951e39fbf6aa1c3/tools/example-showcase/src/main.rs#L723
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
ah right, sorry!
And yeah, looks like the new debug option isn't piped through fromexample-showcase.
Uh oh!
There was an error while loading.Please reload this page.
README.md Outdated
| These pages need to be generated in a separate step by running the shell scripts in the`generate-assets`,`generate-errors`, and`generate-wasm-examples` directories. On Windows, you can use[WSL](https://learn.microsoft.com/en-us/windows/wsl/install) or[git bash](https://gitforwindows.org/). | ||
| The Examples page uses the same WASM binaries ashttps://bevy.org/examples by default. To build examples locally, have a look at`generate-wasm-examples/build_wasm_examples_debug.sh`. After running it, start zola with`zola --config config.local.toml serve` to use the locally built examples. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
The first sentence isslightly confusing for me. I would suggest something like "uses the same pre-built Wasm binaries" to clarify a tiny bit.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I've just pushed a re-wording
Co-authored-by: Rob Parrett <robparrett@gmail.com>
…ite into build-examples-locally
update doc to clarify where to place bevy dir to generate examples locally
Rodhlann left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
This is currently in a usable state for those trying to build and run the UI locally with examples, I think it would be good to merge as is and discuss additional improvements in a new Issue.
The intention behind this PR is to allow contributors to easily build wasm examples locally, useful for example to include debug info.
For contributors, that means they now have access to:
There are a number of things about this (and the current setup as a whole) that I feel are not ideal:
example-showcase build-wasm-examplesgenerates:2D Rendering/Bloom 2Dand the onesexample-showcase build-website-listgenerates:2d-rendering/bloom-2d