ocean icon indicating copy to clipboard operation
ocean copied to clipboard

[Integration][github] Added CODEOWNERS in default mapping and blueprint

Open oiadebayo opened this issue 2 weeks ago • 2 comments

User description

Description

What - Added CODEOWNERS file ingestion as defaults for github integration with blueprint and mappings

Why - Enable tracking of code ownership across github repositories to improve visibility into team responsibilities and file ownership

How - Created githubCodeowners blueprint, implemented itemsToParse logic to parse CODEOWNERS entries, and added skipParsing flag to file retrieval

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)
  • [ ] 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 CODEOWNERS file ingestion support to GitHub integration

  • Created githubCodeowners blueprint for tracking code ownership

  • Implemented itemsToParse logic to parse CODEOWNERS entries

  • Enhanced glob pattern matching to include hidden files


Diagram Walkthrough

flowchart LR
  A["CODEOWNERS File"] -->|"Parse with itemsToParse"| B["Extract Scope & Identifiers"]
  B -->|"Map to Entity"| C["githubCodeowners Blueprint"]
  C -->|"Relate to"| D["githubRepository"]
  E["Glob Pattern Matching"] -->|"Add DOTGLOB flag"| F["Match Hidden Files"]

File Walkthrough

Relevant files
Enhancement
utils.py
Enhanced glob pattern matching for hidden files                   

integrations/github/github/core/exporters/file_exporter/utils.py

  • Added glob.DOTGLOB flag to glob pattern matching function
  • Enables matching of hidden files (files starting with dot)
  • Ensures CODEOWNERS and other dot-prefixed files are properly detected
+3/-1     
blueprints.json
Added githubCodeowners blueprint definition                           

integrations/github/.port/resources/blueprints.json

  • Created new githubCodeowners blueprint definition
  • Added properties for file location and ownership scope
  • Established relation to githubRepository entity
  • Configured schema with required fields and descriptions
+34/-0   
port-app-config.yml
Added CODEOWNERS file resource configuration                         

integrations/github/.port/resources/port-app-config.yml

  • Added file resource kind configuration for CODEOWNERS files
  • Implemented itemsToParse logic to parse CODEOWNERS content
  • Configured file selector to target CODEOWNERS files in specified
    repository
  • Added entity mappings with scope, location, and repository relations
  • Fixed blueprint identifier quoting format for consistency
+36/-1   
Documentation
CHANGELOG.md
Updated changelog for CODEOWNERS support                                 

integrations/github/CHANGELOG.md

  • Added changelog entry for version 3.3.4-beta
  • Documented CODEOWNERS file ingestion support improvement
+8/-0     
Configuration changes
pyproject.toml
Updated package version                                                                   

integrations/github/pyproject.toml

  • Bumped version from 3.3.3-beta to 3.3.4-beta
+1/-1     

oiadebayo avatar Nov 12 '25 13:11 oiadebayo