This library allows you to communicate with the GitLab api. It supports the default gitlab.com but also any other GitLab deployment you might have.

Usage:

// Setup your gitLab or gitLabProject once.
final gitLab  = new GitLab(secretToken);
final gitLabProject = gitLab.project('exit-live');

// Then use it whenever you need in your app.
final allMergeRequests = await gitLabProject.mergeRequests.list();
final allIssues = await gitLabProject.issues.list(page: 3, perPage: 30);
final issue = await gitLabProject.issues.get(allIssues.first.id);

For more information, please refer to the official GitLab API documentation at gitlab.com.

Functions

getTestable(GitLabHttpClient httpClient, [ String token = 'secret-token' ]) GitLab

A helper function to get a GitLab instance with a GitLabHttpClient that can be mocked.

@visibleForTesting

Enums

BuildScope

HttpMethod

IssueOrderBy

IssueSort

IssueState

MergeRequestOrderBy

MergeRequestSort

MergeRequestState

Classes

Build

Commit

CommitsApi

GitLab

The main class and entry point to use this library.

Issue

IssuesApi

JobsApi

The documentation for this API is here: https://docs.gitlab.com/ee/api/jobs.html

MergeRequest

MergeRequestsApi

Pipeline

PipelinesApi

The documentation for this API is here: https://docs.gitlab.com/ee/api/jobs.html

ProjectsApi

Snippet

SnippetsApi

Exceptions / Errors

GitLabException