Update Linear webhooks example with latest implementation

[codegen-sh]

This PR updates the Linear webhooks example with the latest implementation from the Codegen SDK and adds a comprehensive README.md with deployment instructions.

Changes:

1. Updated webhooks.py with:

   • Improved event handling using the latest LinearEvent type
   • Added a handler for Comment events
   • Added proper logging
   • Improved documentation

2. Enhanced .env.template with better documentation and additional variables

3. Updated pyproject.toml with more comprehensive dependencies

4. Added a detailed README.md with:

   • Setup instructions
   • Deployment commands
   • Configuration steps for Linear webhooks
   • Customization guidance
   • Troubleshooting tips
   • Additional resources

These changes make the Linear webhooks example more complete, up-to-date, and easier to use.

---

💻 View my work • About Codegen

Summary by Sourcery

Update the Linear webhooks example to use the latest Codegen SDK implementation, including structured event handling, logging, new comment handler, environment configuration updates, dependency enhancements, and a detailed README.

New Features:

• Add handler for Linear Comment webhook events

Enhancements:

• Use LinearEvent type for issue handlers with structured logging
• Enhance .env.template with additional variables and documentation

Build:

• Update pyproject.toml dependencies to include FastAPI, Uvicorn, Pydantic, and developer tools

Documentation:

• Add comprehensive README with setup, deployment, webhook configuration, customization, troubleshooting, and resource links

[sourcery-ai]

Reviewer's Guide

This PR modernizes the Linear webhooks example by refactoring the webhook handlers to a class-based approach with robust logging and the new LinearEvent type, updating dependencies and environment template, and introducing a comprehensive README for setup, deployment, and troubleshooting.

Sequence Diagram for Linear Webhook Event Processing

sequenceDiagram
    actor L as Linear
    participant M as Modal Platform
    participant H as LinearEventHandlers

    L->>+M: POST /webhook (e.g., Issue Event)
    M->>+H: invoke handle_issue(event: LinearEvent)
    note over M,H: Routing based on @app.linear.event("Issue") decorator
    activate H
    H->>H: logger.info(f"Received Linear Issue event: {event.action} - {event.data.title}")
    H->>H: Process event.data (e.g., event.data.id, event.data.title)
    H-->>-M: Response: {"status": "success", "issue_id": event.data.id, ...}
    M-->>-L: HTTP 200 OK

Loading

Class Diagram for LinearEventHandlers and Core Interactions

classDiagram
    class ModalSecret {
        <<Utility>>
        +from_dotenv()
    }
    class LinearEvent {
        +action: String
        +data: Object
        # ... other LinearEvent fields
    }
    note for LinearEvent "Represents the payload of a Linear webhook event."

    class CodegenApp {
        # ... other CodegenApp properties/methods
        +event_decorator() "app.linear.event()"
        +subscribe_all_handlers() "app.linear.subscribe_all_handlers()"
        +unsubscribe_all_handlers() "app.linear.unsubscribe_all_handlers()"
    }
    note for CodegenApp "Part of Codegen SDK, used for app setup and event handling."

    class LinearEventHandlers {
        <<Modal Deployed Class>>
        +enter() void
        +exit() void
        +handle_issue(event: LinearEvent) dict
        +handle_comment(event: LinearEvent) dict
    }
    note for LinearEventHandlers "New class to handle Linear webhook events.\n- Methods are web endpoints for specific Linear event types.\n- Uses Modal secrets for configuration."

    LinearEventHandlers ..> LinearEvent : consumes
    LinearEventHandlers ..> CodegenApp : uses for lifecycle & event routing
    LinearEventHandlers ..> ModalSecret : uses for configuration (implicitly via @app.cls)

Loading

File-Level Changes

Change	Details	Files
Refactor webhook handlers to use class-based structure with LinearEvent and logging	Updated imports to include LinearEvent and logger Wrapped handlers in LinearEventHandlers class with enter/exit lifecycle methods Replaced generic test handler with handle_issue and handle_comment endpoints Added logging statements for subscription and event processing Added main entry point to deploy via Modal	webhooks.py
Expand and organize project dependencies	Moved dependencies into list format Added FastAPI, Uvicorn, Pydantic dependencies Introduced optional dev dependencies (black, isort, mypy, ruff)	pyproject.toml
Enhance environment template documentation and variables	Created .env.template with detailed placeholders Added new variables for LINEAR_TEAM_ID and MODAL_API_KEY Improved inline documentation for each entry	.env.template
Add comprehensive README with setup and deployment guidance	Documented prerequisites and installation steps Outlined environment config and Modal authentication Provided deployment, status, logs, update and stop commands Described webhook configuration, customization, event types, troubleshooting, and resources	README.md

---

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

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[korbit-ai]

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.

[coderabbitai]

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.

[codegen-sh]

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

💻 View my work

[codegen-sh]

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

💻 View my work