gitlab

node-gitlab

🤖 GitLab API NodeJS library with full support of all the Gitlab API services.

Table of Contents

• Install
• Usage
  • Supported APIs
  • Import
    • Specific Imports
    • Bundle Imports
  • Examples
  • Pagination
  • Sudo
  • Custom Request Libraries
• Migrating from node-gitlab
• Docs
• Development
• Testing
• Contributors
• License
• Changelog

Install

# Install from npm
npm install gitlab

Usage

Supported APIs

The API's that are currently supported are:

// General
ApplicationSettings
BroadcastMessages
Events
FeatureFlags
GeoNodes
GitignoreTemplates
GitLabCIYMLTemplates
Keys
Licence
LicenceTemplates
Lint
Markdown
Namespaces
NotificationSettings
PagesDomains
Search
SidekiqMetrics
Snippets
SystemHooks
Version
Wikis

// Groups
Groups
GroupAccessRequests
GroupBadges
GroupCustomAttributes
GroupIssueBoards
GroupMembers
GroupMilestones
GroupProjects
GroupVariables
Epics
EpicIssues
EpicNotes
EpicDiscussions

// Projects
Branches
Commits
Deployments
DeployKeys
Environments
Issues
IssueNotes
IssueDiscussions
IssueAwardEmojis
Jobs
Labels
MergeRequests
MergeRequestAwardEmojis
MergeRequestNotes
Pipelines
PipelineSchedules
PipelineScheduleVariables
Projects
ProjectAccessRequests
ProjectBadges
ProjectCustomAttributes
ProjectImportExport
ProjectIssueBoards
ProjectHooks
ProjectMembers
ProjectMilestones
ProjectSnippets
ProjectSnippetNotes
ProjectSnippetDiscussions
ProjectSnippetAwardEmojis
ProtectedBranches
ProtectedTags
ProjectVariables
Repositories
RepositoryFiles
Runners
Services
Tags
Todos
Triggers

// Users
Users
UserEmails
UserImpersonationTokens
UserKeys
UserGPGKeys

Import

URL to your GitLab instance should not include /api/v4 path.

Instantiate the library using a basic token created in your Gitlab Profile

// ES6 (>=node 8.9.0)
import { Gitlab } from 'gitlab';

// ES5, assuming native or polyfilled Promise is available
const { Gitlab } = require('gitlab');

// Instantiating
const api = new Gitlab({
  host: 'http://example.com', // Defaults to https://gitlab.com
  token: 'abcdefghij123456', // Can be created in your profile.
});

// Or, use a OAuth token instead!

const api = new Gitlab({
  host: 'http://example.com', // Defaults to https://gitlab.com
  oauthToken: 'abcdefghij123456',
});

// You can also use a CI job token:

const api = new Gitlab({
  url: 'http://example.com', // Defaults to https://gitlab.com
  jobToken: process.env.CI_JOB_TOKEN,
});

Specific Imports

Sometimes you don't want to import and instantiate the whole Gitlab API, perhaps you only want access to the Projects API. To do this, one only needs to import and instantiate this specific API:

import { Projects } from 'gitlab';

const service = new Projects({
  host: 'http://example.com', // Defaults to https://gitlab.com
  token: 'abcdefghij123456', // Can be created in your profile.
});

Bundle Imports

It can be annoying to have to import all the API's pertaining to a specific resource. For example, the Projects resource is composed of many API's, Projects, Issues, Labels, MergeRequests, etc. For convenience, there is a Bundle export for importing and instantiating all these related API's at once.

import { ProjectsBundle } from 'gitlab';

const services = new ProjectsBundle({
  host:   'http://example.com', // Defaults to https://gitlab.com
  token: 'abcdefghij123456' // Can be created in your profile.
})

services.Projects.all()
services.MergeRequests.all()
etc..

Currently there are three Bundles:

1. ProjectsBundle which includes:

Branches
Commits
CommitDiscussions
Deployments
DeployKeys
Environments
Issues
IssueNotes
IssueDiscussions
IssueAwardEmojis
Jobs
Labels
MergeRequests
MergeRequestAwardEmojis
MergeRequestDiscussions
MergeRequestNotes
Pipelines
PipelineSchedules
PipelineScheduleVariables
Projects
ProjectAccessRequests
ProjectBadges
ProjectCustomAttributes
ProjectImportExport
ProjectIssueBoards
ProjectHooks
ProjectMembers
ProjectMilestones
ProjectSnippets
ProjectSnippetNotes
ProjectSnippetDiscussions
ProjectSnippetAwardEmojis
ProtectedBranches
ProtectedTags
ProjectVariables
Repositories
RepositoryFiles
Runners
Services
Tags
Todos
Triggers

1. UsersBundle which includes:

Users,
UserCustomAttributes,
UserEmails,
UserImpersonationTokens,
UserKeys,
UserGPGKeys

1. GroupsBundle which includes:

Groups
GroupAccessRequests
GroupBadges
GroupCustomAttributes
GroupIssueBoards
GroupMembers
GroupMilestones
GroupProjects
GroupVariables
Epics
EpicIssues
EpicNotes
EpicDiscussions

Handling HTTPS certificates

If your Gitlab server is running via HTTPS, the proper way to pass in your certificates is via a NODE_EXTRA_CA_CERTS environment key, like this:

"scripts": {
    "start": "NODE_EXTRA_CA_CERTS=./secrets/3ShapeCA.pem node bot.js"
},

Although we don't encourage it, if you absolutely must allow insecure certificates, you can instantiate the API with rejectAuthorized set to false like this:

const api = new Gitlab({
  url: '...',
  token: '...',
  rejectUnauthorized: false
})

NOTE: Using process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0' will not work with the gitlab library. The rejectUnauthorized key is the only way to allow insecure certificates to be bypassed.

Examples

Once you have your library instantiated, you can utilize many of the API's functionality:

Using the await/async method

import { Gitlab } from 'gitlab';

const api = new Gitlab({
  host: 'http://example.com', // Defaults to https://gitlab.com
  token: 'abcdefghij123456', // Can be created in your profile.
});

// Listing users
let users = await api.Users.all();

// Or using Promise-Then notation
api.Projects.all().then(projects => {
  console.log(projects);
});

General rule about all the function parameters:

• If its a required parameter, it is a named argument in the functions
• If its an optional parameter, it is defined in a options object following the named arguments

ie.

import { Gitlab } from 'gitlab';

const api = new Gitlab({
  host: 'http://example.com', // Defaults to https://gitlab.com
  token: 'abcdefghij123456', // Can be created in your profile.
});

api.Projects.create(projectId, {
  //options defined in the Gitlab API documentation
});

Pagination

For any .all() function on a resource, it will return all the items from Gitlab. This can be troublesome if there are many items, as the request it self can take a while to be fulfilled. As such, a maxPages option can be passed to limit the scope of the all function.

import { Gitlab } from 'gitlab';

const api = new Gitlab({
  host: 'http://example.com', // Defaults to https://gitlab.com
  token: 'abcdefghij123456', // Can be created in your profile.
});

let projects = await api.Projects.all({ maxPages: 2 });

You can also use this in conjunction to the perPage argument which would override the default of 30 per page set by Gitlab:

import { Gitlab } from 'gitlab';

const api = new Gitlab({
  host: 'http://example.com', // Defaults to https://gitlab.com
  token: 'abcdefghij123456', // Can be created in your profile.
});

let projects = await api.Projects.all({ maxPages: 2, perPage: 40 });

Additionally, if you would like to get back the pagination information, to know how many total pages there are for example, pass the pagination option showPagination in addition to either the maxPages or page properties.

...
const { data, pagination } = await api.Projects.all({
  perPage:40,
  maxPages:2,
  showPagination: true
});
...

This will result in a response in this format:

data: [
...
],
pagination: {
  total: 20,
  next: 4,
  current: 2,
  previous: 1,
  perPage: 3,
  totalPages: 3,
}

Sudo

For private gitlab instances, administrators are able to impersonate users through the API. To do so, you have to set the 'Sudo' header on the services you want to impersonate the user for.

For example, if you want to disable notifications for a specific user:

import { NotificationSettings } from 'gitlab';

const service = new NotificationSettings({
  host:   'http://example.com', // Defaults to https://gitlab.com
  token: 'abcdefghij123456' // Can be created in your profile.
  sudo: 8 // Can be the user ID or a username
});

await service.edit({
  level: NotificationSettings.LEVELS.DISABLED
})

Custom Request Libraries

There is another constructor parameter that allows the user to specify their own custom request library as long as it has a similar API to ky. To specify the library, simply set the requester property when instatiating a service:

An example can be seen in the KyRequester.ts file

import { Gitlab } from 'gitlab';
import YourCustomRequester from 'custom-requester';

const api = new Gitlab({
  host:   'http://example.com', // Defaults to https://gitlab.com
  token: 'abcdefghij123456' // Can be created in your profile.
  requester: YourCustomRequester
});

Docs

Although there are the official docs for the API, there are some extra goodies offered by this package! After the 3.0.0 release, the next large project will be putting together proper documentation for these goodies [#39]! Stay tuned!!

Development

To get this running locally rather than from your node_modules folder:

$ git clone https://github.com/jdalrymple/node-gitlab.git
$ cd node-gitlab
$ npm install
$ npm build

And then inside whatever project you are using node-gitlab in you change your references to use that repo. In your package.json of that upstream project change:

  "dependencies": {
    "gitlab": "5.0.0"
  }

to this

  "dependencies": {
    "gitlab": "<path-to-your-clone>"
  }

Testing

Testing is a work-in-progress right now but here is the start.

1. First run Gitlab in a docker container:

docker-compose -f docker-compose.test.yml up

1. Once GitLab is up on localhost:8080, get the two environment variables from the docker image could either export them into environment variables locally:

export PERSONAL_ACCESS_TOKEN=$(docker exec -it gitlab bash -lc 'printf "%q" "${PERSONAL_ACCESS_TOKEN}"')
export GITLAB_URL=$(docker exec -it gitlab bash -lc 'printf "%q" "${GITLAB_URL}"')

1. Now run the tests

npm run test

# or, alternatively
npm run test-with-token # sets PERSONAL_ACCESS_TOKEN and GITLAB_URL from above, before running tests

You can also define them in front of the npm script

PERSONAL_ACCESS_TOKEN='abcdefg' GITLAB_URL='http://localhost:8080' npm run test

Note it may take about 3 minutes to get the variables while Gitlab is starting up in the container

Contributors

This started off as a fork from node-gitlab but I ended up rewriting much of the code. Here are the original work's contributors.

• Dylan DesRosier
• Mike Wyatt
• Cory Zibeill
• Martin Bour
• Christoph Lehmann
• Frank V
• Salim Benabbou
• Tamás Török-Vistai
• Martin Benninger
• Adam Dehnel
• fewieden
• Jeff Pelton
• Claude Abounegm
• Stefan Hall
• Jordan Wallet
• Ev Haus
• zhao0
• Joshua Grosso
• Frédéric Boutin
• Isaac Ouellet Therrien
• Pavel Birukov
• Sharma-Rajat
• Joseph Petersen
• Igor Katsuba
• Giuseppe Angri
• Michael Townsend
• bodtx
• Artem
• Munif Tanjim
• Max Wittig
• Quentin Dreyer
• Norm MacLennan
• jnovick
• Fabian Aussems
• jennparise
• Michael Matzka
• CraigAllardyce
• Bruno Guimarães
• Louis Cherel
• Lukas Eipert
• Maximilian Krauß
• Evolution Gaming
• WEBER Logan
• Anton Zhukov
• Nic Loomans
• Jennifer Everhart
• Carl Kittelberger
• Patrik Votoček
• Kyrylo Fedorov
• Claudio Vellage
• Seb0uil

License

MIT

Changelog

Here