Update examples with deploy.sh scripts and add Deployer.sh for interactive deployment #140
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![codegen-sh[bot]](https://avatars.githubusercontent.com/in/321279?s=60&v=4){kind=small}
# Motivation The **Codegen on OSS** package provides a pipeline that: - **Collects repository URLs** from different sources (e.g., CSV files or GitHub searches). - **Parses repositories** using the codegen tool. - **Profiles performance** and logs metrics for each parsing run. - **Logs errors** to help pinpoint parsing failures or performance bottlenecks. <!-- Why is this change necessary? --> # Content <!-- Please include a summary of the change --> see [codegen-on-oss/README.md](https://github.com/codegen-sh/codegen-sdk/blob/acfe3dc07b65670af33b977fa1e7bc8627fd714e/codegen-on-oss/README.md) # Testing <!-- How was the change tested? --> `uv run modal run modal_run.py` No unit tests yet 😿 # Please check the following before marking your PR as ready for review - [ ] I have added tests for my changes - [x] I have updated the documentation or added new documentation as needed
Original commit by Tawsif Kamal: Revert "Revert "Adding Schema for Tool Outputs"" (codegen-sh#894) Reverts codegen-sh#892 --------- Co-authored-by: Rushil Patel <[email protected]> Co-authored-by: rushilpatel0 <[email protected]>
Original commit by Ellen Agarwal: fix: Workaround for relace not adding newlines (codegen-sh#907)
Reviewer's GuideThis PR standardizes and enriches the examples directory by adding robust per-example deployment scripts, bumping Codegen and Modal versions in project configs, harmonizing documentation across examples, and introducing a root-level interactive Deployer.sh for concurrent multi-example deployments. Sequence Diagram for Deployer.sh Orchestrating Example DeploymentssequenceDiagram
actor User
participant Deployer_sh as "Deployer.sh"
participant Example_deploy_sh as "example/deploy.sh"
participant Modal_Platform as "Modal Platform"
User->>Deployer_sh: Executes ./Deployer.sh
Deployer_sh->>User: Displays list of examples & status
User->>Deployer_sh: Inputs selection (numbers or 'all')
Deployer_sh->>User: Asks for deployment confirmation
User->>Deployer_sh: Confirms (e.g., 'y')
Deployer_sh->>Deployer_sh: Identifies selected examples
loop For each selected example (concurrently)
Deployer_sh->>Example_deploy_sh: Executes ./deploy.sh for the example
activate Example_deploy_sh
Example_deploy_sh->>Example_deploy_sh: Performs environment checks (Python, Modal)
Example_deploy_sh->>Example_deploy_sh: Verifies Modal authentication
Example_deploy_sh->>Example_deploy_sh: Manages .env file (check/create from template)
Example_deploy_sh->>Modal_Platform: Deploys application (e.g., modal deploy app.py)
activate Modal_Platform
Modal_Platform-->>Example_deploy_sh: Deployment status (success/failure)
deactivate Modal_Platform
Example_deploy_sh-->>Deployer_sh: Reports deployment status
deactivate Example_deploy_sh
end
Deployer_sh->>User: Displays overall deployment summary (success/failure counts)
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
|
Important Review skippedBot user detected. To trigger a single review, invoke the You can disable this status message by setting the 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Join our Discord community for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
I see a check failed - I'm on it! 🫡 |
|
✅ Fixed the failing pre-commit check in this commit. The issue was missing newlines at the end of files in the shell scripts and markdown files in the examples directory. I've added the required newlines to ensure the end-of-file-fixer pre-commit hook passes. 💻 View my work • React 👍 or 👎 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the examples in the
codegen-examples/examplesdirectory to use Codegen version 0.52.19 and adds deployment scripts for each example. It also adds a mainDeployer.shscript that allows for interactive selection and concurrent deployment of multiple examples.Changes:
Added
deploy.shscripts to the following examples:Updated
pyproject.tomlfiles to use Codegen version 0.52.19 and Modal version 0.73.25Added or updated README.md files with comprehensive deployment instructions
Created a main
Deployer.shscript in the examples root folder that:Added a README.md file to the examples root folder with instructions on how to use the Deployer.sh script
Each deploy.sh script includes:
The Deployer.sh script provides:
This PR ensures that all examples are executable and up-to-date with both the Modal and Codegen codebases.
💻 View my work • About Codegen
Summary by Sourcery
Update example projects to use Codegen v0.52.19 and Modal v0.73.25, add per-example deploy.sh scripts, and introduce a root-level Deployer.sh for interactive, concurrent deployments while refreshing documentation
New Features:
Enhancements:
Deployment:
Documentation: