ocean
ocean copied to clipboard
[Integration][Gitlab-v2] Added support for gitlab folders as integration default
User description
Description
What - Added support for syncing folders as entities in the GitLab v2 integration with configurable depth patterns
Why - Enable users to discover and map folders from GitLab repositories as service entities in Port, supporting both global patterns across all repos and repo-specific folder patterns
How - Enhanced get_repository_tree() with wildcard pattern matching and depth filtering using fnmatch, updated on_resync_folders() to sync from all projects when repos are unspecified, added default folder mapping with */*/* pattern 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 wildcard pattern matching for GitLab folder discovery with depth filtering
-
Enhanced folder resync to discover folders across all projects when repos unspecified
-
Added default folder mapping configuration with
*/*/*pattern to port-app-config.yml -
Updated version to 0.4.0 and documented improvements in changelog
Diagram Walkthrough
flowchart LR
A["Wildcard Pattern Input"] -->|fnmatch filtering| B["get_repository_tree"]
B -->|depth matching| C["Filtered Folders"]
D["No Repos Specified"] -->|fetch all projects| E["on_resync_folders"]
E -->|iterate projects| F["Sync Folders Across All Repos"]
G["port-app-config.yml"] -->|default folder mapping| H["Folder Entity Creation"]
File Walkthrough
| Relevant files | |||||
|---|---|---|---|---|---|
| Enhancement |
| ||||
| Configuration changes |
| ||||
| Documentation |
|