Skip to content

Update examples with deploy.sh scripts and add Deployer.sh for interactive deployment #140

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 117 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 the examples in the codegen-examples/examples directory to use Codegen version 0.52.19 and adds deployment scripts for each example. It also adds a main Deployer.sh script that allows for interactive selection and concurrent deployment of multiple examples.

Changes:

  1. Added deploy.sh scripts to the following examples:

    • slack_chatbot
    • repo_analytics
    • pr_review_bot
    • github_checks
    • linear_webhooks
    • modal_repo_analytics
    • snapshot_event_handler
  2. Updated pyproject.toml files to use Codegen version 0.52.19 and Modal version 0.73.25

  3. Added or updated README.md files with comprehensive deployment instructions

  4. Created a main Deployer.sh script in the examples root folder that:

    • Shows a list of available examples
    • Allows interactive selection of examples to deploy
    • Deploys selected examples concurrently
    • Provides status reporting and error handling
  5. 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:

  • Environment checks (Python, Modal)
  • Modal authentication verification
  • .env file management
  • Deployment status feedback

The Deployer.sh script provides:

  • Interactive selection of examples
  • Concurrent deployment
  • Status reporting
  • Error handling

This PR ensures that all examples are executable and up-to-date with both the Modal and Codegen codebases.


💻 View my workAbout 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:

  • Add deploy.sh scripts to each example for automated environment checks and deployment

Enhancements:

  • Update pyproject.toml files to Codegen v0.52.19 and Modal v0.73.25

Deployment:

  • Introduce Deployer.sh for interactive, concurrent deployment of selected examples
  • Add individual example deploy.sh scripts with environment validation and status reporting

Documentation:

  • Revise and standardize README.md files with updated setup, deployment, and usage instructions

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 <[email protected]>
Co-authored-by: rushilpatel0 <[email protected]>
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 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 Deployments

sequenceDiagram
    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)
Loading

File-Level Changes

Change Details Files
Introduce and standardize per-example deploy.sh scripts
  • Add deploy.sh to each example with environment and dependency checks
  • Verify Modal CLI authentication and manage .env file templates
  • Implement deployment invocation and real-time status feedback
examples/slack_chatbot/deploy.sh
examples/repo_analytics/deploy.sh
examples/pr_review_bot/deploy.sh
examples/github_checks/deploy.sh
examples/linear_webhooks/deploy.sh
examples/modal_repo_analytics/deploy.sh
examples/snapshot_event_handler/deploy.sh
examples/swebench_agent_run/deploy.sh
Update dependency and project metadata in pyproject.toml files
  • Bump codegen dependency to >=0.52.19 and Modal to >=0.73.25
  • Adjust Python version requirements to 3.13+
  • Add and normalize common dependencies like python-dotenv
examples/linear_webhooks/pyproject.toml
examples/snapshot_event_handler/pyproject.toml
examples/pr_review_bot/pyproject.toml
examples/slack_chatbot/pyproject.toml
examples/swebench_agent_run/pyproject.toml
examples/github_checks/pyproject.toml
examples/repo_analytics/pyproject.toml
Revise and standardize example README.md files
  • Unify structure with prerequisites, setup, deployment, usage sections
  • Include comprehensive deployment commands and troubleshooting tips
  • Link to relevant resources and update output examples
examples/repo_analytics/README.md
examples/slack_chatbot/README.md
examples/snapshot_event_handler/README.md
examples/pr_review_bot/README.md
examples/swebench_agent_run/README.md
examples/linear_webhooks/README.md
examples/README.md
Add root-level Deployer.sh for interactive multi-example deployment
  • Implement interactive menu for selecting examples to deploy
  • Support concurrent deployments with status summary and error handling
  • Provide 'all' and 'quit' options for streamlined flows
examples/Deployer.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 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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants