repository-module-architecture_skill

Overview

This skill documents the Repository module architecture for the CI platform, detailing how the system integrates Git/SVN providers, handles OAuth/token credentials, configures webhooks, and manages triggers. It summarizes submodules, data models, core services, and common flows so developers can implement or extend repository-related features reliably. The guidance targets implementing repository onboarding, webhook processing, and authorization flows across multiple SCM types.

How this skill works

The guide inspects the repository module structure (api, biz, model, boot, plugins) and maps responsibilities across API, service, SCM hub, DAO, and data layers. It explains entity models (T_REPOSITORY and per-type detail tables), supported auth types (HTTP/SSH/OAUTH/GITHUB_APP), token storage, and service registration for SCM-specific implementations. It also describes core flows: repository creation, OAuth authorization, webhook reception, and trigger-to-pipeline mapping.

When to use it

• Design or extend repository onboarding (create/update/delete repositories).
• Implement OAuth or token-based authorization and token storage for SCM providers.
• Add or modify Webhook handling, request recording, or delivery retries.
• Introduce a new SCM provider or extend an existing provider service.
• Integrate repository triggers with pipelines and pipeline-as-code (PAC) features.

Best practices

• Follow the layered structure: api-repository (REST), biz-repository (business logic), SCM hub (provider abstraction), DAO, and model layers.
• Use the service registrar pattern to register SCM-specific services to avoid conditional branching.
• Store provider-specific secrets in dedicated token tables and validate credential lifecycle on create/update.
• Validate URL, alias uniqueness, and credential validity during repository creation flow.
• Record webhook requests and delivery status to enable replay and troubleshooting.

Example use cases

• Add GitHub App support: implement GitHub detail table entries, token table, and a GitHub plugin that registers a CodeGithubRepositoryService.
• Create a new SCM provider: implement service/code/*, register via registrar, add DAO and detail table, and expose API endpoints.
• Implement webhook replay: store webhook requests in T_REPOSITORY_WEBHOOK_REQUEST and build an admin endpoint to replay to pipeline triggers.
• Implement OAuth flow: return provider OAuth URL, handle callback, persist tokens to the provider token table, and link tokens to repository detail rows.