How github/cleanowners works
Main Components
a) Input Layer:
• GitHub Events (workflow_dispatch and scheduled events)
• Configuration Parameters (Environment Variables)
• Authentication Methods (Two options: GitHub App or PAT)
b) Core Processing Components:
• Authentication Handler (auth.py)
• Environment Configuration Manager (env.py)
• CODEOWNERS File Processor (cleanowners.py)
• Report Generator (markdown_writer.py)
c) External Integrations:
• GitHub API
• GitHub Enterprise (optional)
• Repository CODEOWNERS files
[Triggers] → [Configuration] → [Processing] → [Output]
Component Relationships
Triggers → Configuration Manager
• ↓
Authentication Handler ←→ GitHub API
• ↓
CODEOWNERS Processor → GitHub API
• ↓
Report Generator → [Issues/Pull Requests]
Important Details
a) Input Configuration Section:
• Environment Variables (GH_TOKEN, ORGANIZATION, etc.)
• Authentication Options (GitHub App or PAT)
• Optional Parameters (EXEMPT_REPOS, DRY_RUN, etc.)
b) Processing Flow:
• Authentication validation
• Repository scanning
• CODEOWNERS file processing
• User validation against organization
c) Output Options:
• Pull Request creation
• Issue Report generation
• Dry Run logging
Technical Details to Note
• Python 3.11 runtime environment
• Docker container support
• GitHub Actions workflow integration
• API permission requirements