Phani/GitHub deploy docs #80
Conversation
Mesa DescriptionAdd GitHub deployment documentationAdded comprehensive documentation for deploying Kernel apps directly from GitHub repositories, covering:
The deployment guide has been reorganized with clearer hierarchy, presenting "From local directory" and "From GitHub" as sibling deployment methods under "Deploy the app" for improved developer experience and discoverability. Description generated by Mesa. Update settings |
![mesa-dot-dev[bot]](https://avatars.githubusercontent.com/in/1050077?s=60&v=4){kind=small}
There was a problem hiding this comment.
Performed full review of e68644d...946865c
Analysis
While this PR enhances GitHub-based deployment functionality, there are no explicit architectural issues identified in the analysis. The analysis only highlights positive aspects such as good abstraction, feature discoverability, information architecture, and API design. Without additional critical feedback, I cannot identify specific architectural concerns with the implementation.
Tip
⚡ Quick Actions
This review was generated by Mesa.
Actions:
Slash Commands:
/review- Request a full code review/review latest- Review only changes since the last review/describe- Generate PR description. This will update the PR body or issue comment depending on your configuration/help- Get help with Mesa commands and configuration options
2 files reviewed | 0 comments | Review on Mesa | Edit Reviewer Settings
masnwilliams
left a comment
masnwilliams
left a comment
There was a problem hiding this comment.
Just a few things here
|
|
||
| ## Environment variables | ||
|
|
||
| You can set environment variables for your app using the `--env` flag. For example: |
There was a problem hiding this comment.
Can we also show an example using --env-file .env with an env file instead of in-line values?
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.
There was a problem hiding this comment.
Added! Now showing both --env inline and --env-file .env examples in the CodeGroup.
| ``` | ||
|
|
||
| #### Notes | ||
| - **`--path` vs `--entrypoint`:** Use `--path` to specify a subdirectory within the repo (useful for monorepos), and `--entrypoint` for the path to your app's entry file relative to that directory (or repo root if no `--path` is specified). |
There was a problem hiding this comment.
Does this apply to local directory deployment too? If so, I would suggest moving it to the Deployment Notes section that is more general.
There was a problem hiding this comment.
The local directory deployment only uses entrypoint_file_name. It is specific to the github approach only.
| - **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.** | ||
| - Include a `.gitignore` file to exclude dependency folders like `node_modules` and `.venv`. | ||
| - **The dependency manifest (`package.json` for JS/TS, `pyproject.toml` for Python) must be present in the root directory of your project.** | ||
| - View deployment logs using: `kernel deploy logs <deployment_id> --follow` |
There was a problem hiding this comment.
Can we add a bullet here that says something like "If you see 500 error returned during deployment, please ensure you have specified the entrypoint file name and type correctly.". We had a ticket in Linear related to a user seeing this error.
There was a problem hiding this comment.
Yeah, that's a nice to have!
Something like this should be good:-
- If you encounter a 500 error during deployment, verify that your entrypoint file name and extension are correct (e.g.,
app.pynotapporapp.js).
lmk what you think?
Add GitHub deployment documentation
Added comprehensive documentation for deploying Kernel apps directly from GitHub repositories, covering:
--url,--ref,--entrypoint,--path,--github-token, and environment variable configurationThe deployment guide has been reorganized with clearer hierarchy, presenting "From local directory" and "From GitHub" as sibling deployment methods under "Deploy the app" for improved developer experience and discoverability.