Jakub Dobry
e244ba72c0
## Description Add option for a template ready check. You can specify `ready_cmd` which will be run until it exits with code 0. Max timeout is 5 minutes. After exit code 0, the template will be marked as ready. If no ready command is defined, `sleep 20` is assumed when the start command is present, and `sleep 0` when none is defined. It is also possible to define ready command without any start command. This might be helpful if the filesystem contains self-booted services (e.g. using systemd). ``` ready_cmd = "echo 'Starting ready check'; sleep 40; echo 'Template is ready'" ``` This adds possibility to configure the default 20 seconds wait time for a start command. New documentation can be found at `/docs/sandbox-template/ready-cmd`. ## Checklist - [x] Make sure the https://github.com/e2b-dev/infra/pull/719 is deployed --------- Co-authored-by: Vasek Mlejnsky <vasek@e2b.dev> Co-authored-by: Jakub Novák <jakub@e2b.dev>
E2B Web App
This repository contains E2B Dashboard, documentation, and SDK references.
SDK References
The SDK references are generated from the source code in the packages folder.
Each package has its own SDK reference generator found in {package-dir}/scripts/generate_sdk_ref.sh, it generates markdown files with the following schema: ./src/app/(docs)/docs/sdk-reference/{package-name}/{version}/{module-name}/page.mdx.
When pushed to main, a github workflow checks for diffs in the packages folder, and if any are found, the SDK reference generator is run and the result is auto-commited the incoming branch.
Finally, when building or running the dev server, a prebuild step is run beforehand to generate the SDK reference TOCs and routes in the sdk-reference directory. This can also be run manually using npm run prebuild.
note: sometimes you may see uncommited changes or untracked files in the sdk-reference directory, this is fine and the files can be ignored.