How cooperspencer/gickup works
Main Components Identification
The system can be broken down into three main layers:
a. Core Layer:
• Main application logic (main.go)
• Configuration handling (conf.example.yml)
• Type definitions (types/)
b. Source Providers Layer:
• GitHub
• GitLab
• Gitea
• Gogs
• Bitbucket
• OneDev
• Sourcehut
• Whatever (generic Git)
c. Destination Providers Layer:
• All source providers (except Whatever)
• Local storage
• S3 storage
d. Metrics/Monitoring Layer:
• Gotify
• Heartbeat
• Ntfy
• Prometheus
Detailed Component Breakdown
Core Layer (Blue):
• Gickup Core |
• Configuration |
• Type Definitions |
• Git Commands |
• Logger |
Source Providers (Green):
• Source Providers |
• GitHub |
• GitLab |
• Gitea |
• Gogs |
• Bitbucket |
• OneDev |
• Sourcehut |
• Whatever (Generic) |
Destination Providers (Orange):
• Destination Providers |
• GitHub |
• GitLab |
• Gitea |
• Gogs |
• OneDev |
• Sourcehut |
• Local |
• S3 |
Metrics Layer (Purple):
• Metrics/Monitoring |
• Gotify |
• Heartbeat |
• Ntfy |
• Prometheus |
Flow Representation
• From source providers to core
• From core to destination providers
• From core to metrics layer
Additional Elements
• Notes about configuration requirements
• External dependencies (Git commands, S3 SDK)
• Deployment options (Docker, binary)