-
Notifications
You must be signed in to change notification settings - Fork 3
Phani/GitHub deploy docs #80
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
Changes from 2 commits
d0def05
946865c
d9ed45f
fa5a277
b1207f2
0e7259f
36db6ef
ad4c9a8
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,12 +9,41 @@ Once you deploy an app on Kernel, you can schedule its actions on a job or run t | |
|
|
||
| ## Deploy the app | ||
|
|
||
| ### From local directory | ||
|
|
||
| Use our CLI from the root directory of your project: | ||
| ```bash | ||
| # entrypoint_file_name should be where you've defined your Kernel app | ||
| kernel deploy <entrypoint_file_name> | ||
| ``` | ||
|
|
||
| #### Notes | ||
|
|
||
| - The `entrypoint_file_name` is the file name where you [defined](/apps/develop) your app. | ||
| - Include a `.gitignore` file to exclude dependency folders like `node_modules` and `.venv`. | ||
|
|
||
| ### From GitHub | ||
|
|
||
| You can deploy an app directly from a public or private GitHub repository using the Kernel CLI — no need to clone or manually push code. | ||
|
|
||
| ```bash | ||
| kernel deploy github \ | ||
| --url https://github.com/<owner>/<repo> \ | ||
| --ref <branch|tag|commit> \ | ||
| --entrypoint <path/to/entrypoint> \ | ||
| [--path <optional/subdir>] \ | ||
jarugupj marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| [--github-token <token>] \ | ||
| [--env KEY=value ...] \ | ||
| [--env-file .env] \ | ||
| [--version latest] \ | ||
| [--force] | ||
| ``` | ||
|
|
||
| #### Notes | ||
|
|
||
| - The CLI automatically downloads and extracts the GitHub source, prunes large dependency folders (like `node_modules`), and uploads your app for deployment. | ||
jarugupj marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - For private repositories, provide a `--github-token` or set the `GITHUB_TOKEN` environment variable. | ||
|
|
||
| ## Environment variables | ||
|
|
||
| You can set environment variables for your app using the `--env` flag. For example: | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can we also show an example using I find this is an easier pattern to replicate and one I use most consistently. I know this isn't exactly related to the branch, but thought I would just ask to have it included.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Added! Now showing both --env inline and --env-file .env examples in the CodeGroup. |
||
|
|
@@ -31,9 +60,8 @@ kernel deploy my_app.py --env MY_ENV_VAR=my_value # Can add multiple env vars de | |
|
|
||
| ## Deployment notes | ||
|
|
||
| - The `entrypoint_file_name` is the file name where you [defined](/apps/develop) your app. | ||
| - **The entrypoint file and dependency manifest (`package.json` for JS/TS, `pyproject.toml` for Python) must both be in the root directory of your project.** | ||
jarugupj marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - Include a `.gitignore` file to exclude dependency folders like `node_modules` and `.venv`. | ||
| - View deployment logs using: `kernel deploy logs <deployment_id> --follow` | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can we add a bullet here that says something like "If you see
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yeah, that's a nice to have! Something like this should be good:-
lmk what you think? |
||
| - Kernel assumes the root directory contains at least this file structure: | ||
jarugupj marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| <CodeGroup> | ||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.