Skip to content

Update Modal examples with Codegen 0.52.19 and add deployment scripts #139

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

Draft
wants to merge 116 commits into
base: develop
Choose a base branch
from

Conversation

codegen-sh[bot]
Copy link

@codegen-sh codegen-sh bot commented May 17, 2025

This PR updates all Modal examples in the Codegen repository to use Codegen version 0.52.19 specifically and adds deployment infrastructure:

What's Changed

New Features

  • Added interactive Deployer.sh script in the examples folder that allows selecting and deploying multiple Modal examples concurrently
  • Created deploy.sh scripts for each Modal example
  • Added comprehensive README.md files for all Modal examples
  • Created a new hello_world example that demonstrates basic Modal functionality

Updates

  • Updated all Modal examples to use Codegen version 0.52.19 specifically:
    • modal_repo_analytics
    • modal_repo_rag
    • linear_webhooks
    • swebench_agent_run
  • Updated the main examples README.md with comprehensive documentation

Technical Details

  • All Modal images now install codegen==0.52.19 instead of using flexible version constraints
  • All deployment scripts include environment checks and error handling
  • The Deployer.sh script supports concurrent deployment with status tracking
  • All scripts are made executable with proper permissions

Testing

  • Verified that all Modal examples are compatible with Codegen 0.52.19
  • Tested the Deployer.sh script for proper functionality
  • Ensured all deploy.sh scripts work correctly

This PR ensures that all Modal examples are up-to-date, well-documented, and easy to deploy.


💻 View my workAbout Codegen

Summary by Sourcery

Update all Modal examples to pin Codegen SDK at 0.52.19, add a new hello_world tutorial, and introduce deployment infrastructure with interactive and per-example deploy scripts alongside improved documentation.

New Features:

  • Add interactive Deployer.sh script for selecting and deploying multiple Modal examples concurrently
  • Add individual deploy.sh scripts for each Modal example
  • Create comprehensive user-facing README.md files for all Modal examples
  • Introduce new hello_world example demonstrating basic Modal functionality

Enhancements:

  • Pin Codegen SDK dependency to version 0.52.19 across all Modal examples
  • Update package.json to include a fixed Yarn packageManager version

Deployment:

  • Provide a top-level Deployer.sh and per-example deploy.sh scripts to automate Modal deployments

Documentation:

  • Add and update documentation in per-example README.md files and a central examples README

clee-codegen and others added 30 commits February 26, 2025 23:54
# 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 <rpatel@codegen.com>
Co-authored-by: rushilpatel0 <171610820+rushilpatel0@users.noreply.github.com>
Original commit by Ellen Agarwal: fix: Workaround for relace not adding newlines (codegen-sh#907)
Copy link

sourcery-ai bot commented May 17, 2025

Reviewer's Guide

This PR standardizes all Modal examples to use Codegen v0.52.19, enriches documentation across examples, and introduces robust deployment tooling including an interactive Deployer script and per-example deploy scripts.

Sequence Diagram for Deployer.sh Interaction Flow

sequenceDiagram
    actor User
    participant Deployer_sh as "Deployer.sh"
    participant Example_Deploy_sh as "example/deploy.sh"
    participant Modal_CLI as "Modal CLI"
    participant Modal_Platform as "Modal Platform"

    User->>Deployer_sh: Execute script
    Deployer_sh->>Modal_CLI: Check installed
    Modal_CLI-->>Deployer_sh: Status
    Deployer_sh->>Modal_CLI: Check authenticated
    Modal_CLI-->>Deployer_sh: Status
    alt Modal checks fail
        Deployer_sh->>User: Show error and exit
    end
    Deployer_sh->>Deployer_sh: Find examples with deploy.sh
    Deployer_sh->>User: Display available examples
    User->>Deployer_sh: Select examples (numbers or 'all')
    Deployer_sh->>User: Confirm selection
    User->>Deployer_sh: Confirm (y)
    loop For each selected example
        Deployer_sh->>Example_Deploy_sh: Execute ./deploy.sh (concurrently)
        Note over Example_Deploy_sh: Runs 'modal deploy ...'
        Example_Deploy_sh->>Modal_Platform: Deploy application
        Modal_Platform-->>Example_Deploy_sh: Deployment status
        Example_Deploy_sh-->>Deployer_sh: Log status to /tmp/
    end
    Deployer_sh->>User: Report deployment status for all examples
Loading

Class Diagram for New 'hello_world' Modal Application

classDiagram
    direction LR
    class App_hello_world {
      <<ModalApp>>
      name: "hello-world"
    }
    class Image_hw {
      <<ModalImage>>
      +pip_install(["codegen==0.52.19"])
      # Based on debian_slim()
    }
    class Func_hello {
      <<ModalFunction>>
      +hello(name: str)
    }
    class Func_web_hello {
      <<ModalWebEndpoint>>
      +web_hello(name: str)
      method: "GET"
      keep_warm: 1
    }
    class Func_scheduled_hello {
      <<ModalScheduledFunction>>
      +scheduled_hello()
      schedule_rate: "1 hour"
    }

    App_hello_world --o Image_hw : uses
    App_hello_world --o Func_hello : defines
    Func_hello ..> Image_hw : uses_image
    App_hello_world --o Func_web_hello : defines
    Func_web_hello ..> Image_hw : uses_image
    App_hello_world --o Func_scheduled_hello : defines
    Func_scheduled_hello ..> Image_hw : uses_image

    note for App_hello_world "New Modal application demonstrating basic functionalities."
Loading

Class Diagram Highlighting Updated 'Modal.Image' Configuration for Codegen Version

classDiagram
    class ModalImage {
        <<Modal.Image>>
        +pip_install(dependencies: list)
        +run_commands(commands: list)
        # Other methods like debian_slim(), apt_install()
    }
    note for ModalImage "Updated to ensure 'codegen==0.52.19' is installed.\nThis affects image definitions in:\n- linear_webhooks/webhooks.py (via pip_install)
- modal_repo_analytics/api.py (via pip_install)
- modal_repo_rag/api.py (via pip_install)
- swebench_agent_run/.../entry_point.py (via run_commands)"
Loading

File-Level Changes

Change Details Files
Pin Codegen SDK to 0.52.19 across all examples
  • Replaced flexible version constraints with exact codegen==0.52.19 in image pip installs
  • Updated package.json dependencies accordingly
codegen-examples/examples/modal_repo_rag/api.py
codegen-examples/examples/modal_repo_analytics/api.py
codegen-examples/examples/linear_webhooks/webhooks.py
codegen-examples/examples/swebench_agent_run/modal_harness/entry_point.py
package.json
codegen-examples/examples/hello_world/app.py
Add deployment infrastructure
  • Introduced root-level Deployer.sh for interactive, concurrent example deployments
  • Created deploy.sh in each example with environment checks, volume setup, and error handling
Deployer.sh
codegen-examples/examples/modal_repo_rag/deploy.sh
codegen-examples/examples/modal_repo_analytics/deploy.sh
codegen-examples/examples/linear_webhooks/deploy.sh
codegen-examples/examples/hello_world/deploy.sh
Revamp and add example READMEs
  • Rewrote modal_repo_rag, modal_repo_analytics, swebench_agent_run READMEs with feature lists and quickstart
  • Added comprehensive READMEs for linear_webhooks, hello_world, and top-level examples directory
codegen-examples/examples/modal_repo_rag/README.md
codegen-examples/examples/modal_repo_analytics/README.md
codegen-examples/examples/swebench_agent_run/README.md
codegen-examples/examples/linear_webhooks/README.md
codegen-examples/examples/hello_world/README.md
codegen-examples/examples/README.md
Introduce new hello_world example
  • Demonstrates basic Modal app with web endpoint and scheduled function
  • Includes dedicated README and deploy script
codegen-examples/examples/hello_world/app.py
codegen-examples/examples/hello_world/README.md
codegen-examples/examples/hello_world/deploy.sh

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

korbit-ai bot commented May 17, 2025

By default, I don't review pull requests opened by bots. If you would like me to review this pull request anyway, you can request a review via the /korbit-review command in a comment.

Copy link

coderabbitai bot commented May 17, 2025

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Author

codegen-sh bot commented May 17, 2025

I see a check failed - I'm on it! 🫡

💻 View my work

Copy link
Author

codegen-sh bot commented May 17, 2025

✅ Fixed the failing mypy check in this commit.

The issue was a duplicate module name error because both modal_repo_analytics and modal_repo_rag directories had files named api.py. I renamed modal_repo_rag/api.py to modal_repo_rag/rag_api.py and updated the corresponding deploy.sh script to reference the new filename.

This change ensures that mypy can properly analyze the codebase without confusion between the two modules.

💻 View my work • React 👍 or 👎

Copy link
Author

codegen-sh bot commented May 17, 2025

I see a check failed - I'm on it! 🫡

💻 View my work

Copy link
Author

codegen-sh bot commented May 17, 2025

✅ Fixed the failing pre-commit check in this commit.

The issues were related to formatting problems:

  1. Trailing whitespace in shell scripts
  2. Missing newlines at the end of files
  3. Python formatting issues in app.py
  4. Markdown formatting inconsistencies

I've fixed all these issues by:

  • Removing trailing whitespace
  • Adding newlines at the end of files
  • Running ruff format on Python files
  • Running mdformat on Markdown files

The PR should now pass all checks.

💻 View my work • React 👍 or 👎

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants