ocean icon indicating copy to clipboard operation
ocean copied to clipboard

[Integration][Gitlab-v2] Added support for gitlab folders as integration default

Open oiadebayo opened this issue 6 days ago • 2 comments

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 examples folder 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
gitlab_client.py
Implement wildcard pattern matching for folder discovery 

integrations/gitlab-v2/gitlab/clients/gitlab_client.py

  • Added fnmatch import for wildcard pattern matching
  • Enhanced get_repository_tree() to support wildcard patterns with depth
    filtering
  • Implemented dual-path logic: recursive search for wildcards,
    non-recursive for exact paths
  • Filters folders by matching pattern depth and fnmatch criteria
+34/-8   
main.py
Enable folder syncing across all projects when unspecified

integrations/gitlab-v2/main.py

  • Modified on_resync_folders() to sync from all projects when repos list
    is empty
  • Added logic to fetch all projects and iterate through them for folder
    discovery
  • Changed behavior from skipping to actively syncing folders across all
    repositories
  • Improved logging to show folder counts per project
+23/-8   
Configuration changes
port-app-config.yml
Add default folder resource configuration                               

integrations/gitlab-v2/.port/resources/port-app-config.yml

  • Added new folder resource kind with default configuration
  • Configured default folder selector with */*/* wildcard pattern
  • Added folder entity mappings with identifier, title, blueprint, and
    properties
  • Included folder URL generation and repository description in
    properties
+17/-0   
pyproject.toml
Update project version to 0.4.0                                                   

integrations/gitlab-v2/pyproject.toml

  • Bumped version from 0.3.24 to 0.4.0
+1/-1     
Documentation
CHANGELOG.md
Document version 0.4.0 improvements                                           

integrations/gitlab-v2/CHANGELOG.md

  • Added version 0.4.0 release notes
  • Documented improvements for folder syncing from specific repositories
    and branches
  • Noted addition of folder kind to integration defaults
+9/-0     

oiadebayo avatar Nov 24 '25 17:11 oiadebayo