Інтеграція GitLab API з сайтом

Інтеграція GitLab API з веб-сайтом

GitLab API використовується для CI/CD інтеграцій, відображення статусу пайплайнів, управління завданнями з зовнішніх систем та авторизації через GitLab OAuth. Особливо актуально для DevOps-інструментів та корпоративних порталів.

Аутентифікація

import gitlab

# Personal Access Token
gl = gitlab.Gitlab('https://gitlab.com', private_token=GITLAB_TOKEN)

# OAuth2 для користувальницьких додатків
gl = gitlab.Gitlab('https://gitlab.com', oauth_token=oauth_token)

Типові сценарії

Статус CI/CD пайплайна на сайті:

def get_pipeline_status(project_id: int, ref: str = 'main') -> dict:
    project   = gl.projects.get(project_id)
    pipelines = project.pipelines.list(ref=ref, per_page=1)

    if not pipelines:
        return {'status': 'unknown'}

    pipeline = pipelines[0]
    return {
        'status':     pipeline.status,      # success/failed/running/pending
        'ref':        pipeline.ref,
        'sha':        pipeline.sha[:8],
        'started_at': pipeline.started_at,
        'duration':   pipeline.duration,
        'url':        pipeline.web_url,
    }

Спусти пайплайна з адміністративної панелі:

public function triggerDeploy(Request $request): JsonResponse
{
    $resp = Http::withToken(config('services.gitlab.token'))
        ->post("https://gitlab.com/api/v4/projects/{$projectId}/pipeline", [
            'ref'       => 'main',
            'variables' => [
                ['key' => 'DEPLOY_ENV', 'value' => $request->environment],
            ],
        ]);

    return response()->json(['pipeline_id' => $resp->json('id')]);
}

GitLab OAuth2

Route::get('/auth/gitlab/redirect', function () {
    return redirect('https://gitlab.com/oauth/authorize?' . http_build_query([
        'client_id'     => config('services.gitlab.client_id'),
        'redirect_uri'  => route('auth.gitlab.callback'),
        'response_type' => 'code',
        'scope'         => 'read_user read_api',
    ]));
});

Webhooks

GitLab підтримує Push Events, Pipeline Events, Merge Request Events. Верифікація через заголовок X-Gitlab-Token (секретний токен, заданий під час створення webhook).

Графік

Відображення статусу пайплайна + OAuth: 2–3 робочих дні. Повна інтеграція з управлінням: 4–5 днів.