ocean
ocean copied to clipboard
[Integration][Github] Added folder kind as integration default
User description
Description
What - Added folder kind to GitHub integration defaults with //* pattern for 3-level deep directory matching
Why - Enable users to discover and map repository folders as entities in Port without manual configuration
How - Added default folder mapping to port-app-config.yml
Type of change
Please leave one option from the following and delete the rest:
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] New Integration (non-breaking change which adds a new integration)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [x] Non-breaking change (fix of existing functionality that will not change current behavior)
- [ ] Documentation (added/updated documentation)
All tests should be run against the port production environment(using a testing org).
Core testing checklist
- [ ] Integration able to create all default resources from scratch
- [ ] Resync finishes successfully
- [ ] Resync able to create entities
- [ ] Resync able to update entities
- [ ] Resync able to detect and delete entities
- [ ] Scheduled resync able to abort existing resync and start a new one
- [ ] Tested with at least 2 integrations from scratch
- [ ] Tested with Kafka and Polling event listeners
- [ ] Tested deletion of entities that don't pass the selector
Integration testing checklist
- [ ] Integration able to create all default resources from scratch
- [ ] Completed a full resync from a freshly installed integration and it completed successfully
- [ ] Resync able to create entities
- [ ] Resync able to update entities
- [ ] Resync able to detect and delete entities
- [ ] Resync finishes successfully
- [ ] 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. - [ ] If resource kind is updated, run the integration with the example data and check if the expected result is achieved
- [ ] If new resource kind is added or updated, validate that live-events for that resource are working as expected
- [ ] Docs PR link here
Preflight checklist
- [ ] Handled rate limiting
- [ ] Handled pagination
- [ ] Implemented the code in async
- [ ] 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
Enhancement
Description
-
Added folder kind as default resource to GitHub integration
-
Enables automatic discovery of 3-level deep directories
-
Folders mapped as entities linked to repository blueprint
-
Updated version to 4.2.0-beta with changelog entry
Diagram Walkthrough
flowchart LR
GH["GitHub API"] -- "folders with */*/*" --> Selector["Folder Selector"]
Selector -- "maps to entities" --> Folder["Folder Entity"]
Folder -- "relates to" --> Repo["Repository Blueprint"]
File Walkthrough
| Relevant files | |||
|---|---|---|---|
| Enhancement |
| ||
| Documentation |
| ||
| Configuration changes |
|