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 introduces comprehensive
TypedDictdefinitions for GitHub webhook events insrc/sentry/integrations/github/webhook_types.py.The primary goal is to enhance type safety, improve developer experience with better autocomplete, and provide clearer documentation of expected webhook payload structures within the GitHub integration.
Key changes include:
TypedDictclasses for common GitHub objects (e.g.,GitHubUser,GitHubRepository,GitHubPullRequest) and specific webhook event types (e.g.,PushWebhookEvent,PullRequestWebhookEvent).src/sentry/integrations/github/webhook.pyto leverage these new types.mypypasses by strategically usingMapping[str, Any]in public method signatures (to maintain compatibility with parent classes) and casting to specificTypedDicttypes internally for more precise type checking.Legal Boilerplate
Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.
Slack Thread