Integrations: skip processing webhook events for GitHub App projects #12542
+102
−0
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
There was a problem hiding this comment.
Pull Request Overview
This PR adds a deprecation warning mechanism for projects that are connected to the GitHub App but still have webhook integrations configured. The changes create a notification to alert users that they should remove the deprecated webhook integration.
Key changes:
- Adds a new notification message type for deprecated webhooks
- Implements logic to create notifications when webhook requests are received for GitHub App projects
- Adds functionality to dismiss the notification when the deprecated webhook is deleted
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| readthedocs/projects/notifications.py | Defines the new notification message constant and its content for the deprecated webhook warning |
| readthedocs/api/v2/views/integrations.py | Implements early return logic in GitHub webhook handler to reject requests and create notifications for GitHub App projects |
| readthedocs/projects/views/private.py | Adds logic to dismiss the deprecated webhook notification when an integration is deleted |
| readthedocs/rtd_tests/tests/test_api.py | Adds test coverage for the new GitHub App project webhook skipping behavior |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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.
Having a webhook on projects already linked to our GH App leads to duplicate builds.