ocean
ocean copied to clipboard
[Integration][Github] added github integration to ocean
User description
Description
What - Added github integration to ocean
Why - To sync some github resources via the ocean framework
How - Used webhooks to listen for github events, and ocean's httpx async custom package to fetch the data from github api
Type of change
Please leave one option from the following and delete the rest:
- [x ] New Integration (non-breaking change which adds a new integration)
All tests should be run against the port production environment(using a testing org).
Core testing checklist
- [ x] Integration able to create all default resources from scratch
- [x ] Resync finishes successfully
- [x ] Resync able to create entities
- [ x] Resync able to update entities
- [x ] Resync able to detect and delete entities
- [ x] Scheduled resync able to abort existing resync and start a new one
- [x ] Tested with at least 2 integrations from scratch
- [ x] Tested with Kafka and Polling event listeners
- [ x] Tested deletion of entities that don't pass the selector
Integration testing checklist
- [x ] Integration able to create all default resources from scratch
- [x ] Resync able to create entities
- [x ] Resync able to update entities
- [ x] Resync able to detect and delete entities
- [ x] Resync finishes successfully
- [x ] If new resource kind is added or updated in the integration, add example raw data, mapping and expected result to the
examplesfolder in the integration directory. - [ x] If resource kind is updated, run the integration with the example data and check if the expected result is achieved
- [x ] If new resource kind is added or updated, validate that live-events for that resource are working as expected
- [x ] Docs PR link here
Preflight checklist
- [x ] Handled rate limiting
- [ x] Handled pagination
- [x ] Implemented the code in async
- [ x] Support Multi account
Screenshots
Include screenshots from your environment showing how the resources of the integration will look.
API Documentation
Provide links to the API documentation used for this integration.
PR Type
New Integration, Enhancement, Tests
Description
-
Added a new GitHub integration to Ocean for syncing GitHub resources.
-
Implemented webhook processors for GitHub events (issues, pull requests, teams, workflows, etc.).
-
Developed extensive test cases for the GitHub client and webhook processors.
-
Created configuration files for integration setup, including
.env.example,blueprints.json, andport-app-config.yaml.
Changes walkthrough 📝
| Relevant files | |||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Enhancement | 13 files
| ||||||||||||||||||||||||||
| Tests | |||||||||||||||||||||||||||
| Configuration changes | 6 files
| ||||||||||||||||||||||||||
| Documentation | |||||||||||||||||||||||||||
| Dependencies | |||||||||||||||||||||||||||
| Additional files |
Need help?
Type /help how to ...in the comments thread for any questions about Qodo Merge usage.Check out the documentation for more information.


