api

anonymous@undisclosed.example.com (Anonymous) — Wed, 27 Jan 2016 06:35:19 +0000

GitLab provides a powerful API that lets you interact programmatically with a GitLab instance in order to automate a lot of things.

This tutorial presents how to use the API of GitLab with Python. Of course you can use your favorite language.

For the examples below we will use the instance https://gitlab.example.org. Of course you can use https://gitlab.com.

Get the list of users registered in GitLab

This first example is fairly easy and takes advantage of the Users resource.

#! /usr/bin/env python
#-*- coding: utf-8 -*-
 
import requests
import json
 
# your private token can be found here:
# https://gitlab.example.org/profile/account
TOKEN = "<your-private-token>"
 
r = requests.get("https://gitlab.example.org/api/v3/users?per_page=100&private_token="+TOKEN)
 
if r.status_code == 200:
    users = json.loads(r.content)
    for user in users:
        print user["username"], user["email"]

The requests library is used to query the API and the json library is used to parse the result received from the server. Here the result is simply a list of users.

Send an email to the members of a GitLab group

Again, this is pretty easy. We will need the Groups resource and the Users resource.

In order to send the email, we will simply use the Mutt email client.

The Mutt command will look like this:

$ mutt -s "The subject" `./get_recipents.py <group-id> /dev/null` < message.txt

As you can see, Mutt needs three parameters:

the subject of the email. Will be given in parameter;
the message to be sent. Will be given through a Unix pipeline (message.txt);
the list of recipients (members of the GitLab group). Will be given in parameter as the result of a Python script.

As you can expect, the Python script will use the API of GitLab in order to get the list of recipients. Below you will find a working script:

#! /usr/bin/env python
#-*- coding: utf-8 -*-
 
import requests
import json
 
# your private token can be found here:
# https://gitlab.example.org/profile/account
TOKEN = "<your-private-token>"
GROUP_ID = 21
 
EMAILS = []
 
r = requests.get("https://gitlab.example.org/api/v3/groups/" + str(GROUP_ID) + "/members?private_token=" + TOKEN)
 
if r.status_code == 200:
    members = json.loads(r.content)
    for member in members:
        r = requests.get("https://gitlab.example.org/api/v3/users/" + str(member["id"]) + "?private_token=" + TOKEN)
        if r.status_code == 200:
            user = json.loads(r.content)
            if user["state"] == "active":
                EMAILS.append(user["email"])

A first request to the Groups resource returns the list of members in the group. The for loop iterates through these members in order to get their email.

Only active users (user[“state”] == “active”) will receive the email.

convert-subversion-to-git

anonymous@undisclosed.example.com (Anonymous) — Wed, 27 Jan 2016 06:15:57 +0000

Migrating a Subversion repository to Git on your GitLab instance

#! /bin/sh
 
#
# Migrating a SVN repository to Git
#
# This script requires a mapping file (users.txt) in this format:
#
#username1 = firstname1 lastname1 <email1>
#username2 = firstname2 lastname2 <email2>
#
# To get a list of the author names that SVN uses, you can run this:
#svn log ^/ --xml | grep -P "^<author" | sort -u | perl -pe 's/<author>(.*?)<\/author>/$1 = /' > users.txt
#
 
SVN_repository=http://subversion.list.lu/svn/<project-name>
authors_file=./users.txt
GIT_repository_name=<project-name>
GIT_repository_server=git@git.list.lu:<group-name>/<project-name>.git
 
 
git svn clone $SVN_repository --authors-file=$authors_file --no-metadata -s $GIT_repository_name
# For a non standard SVN repository:
#git svn clone $SVN_repository --no-minimize-url --authors-file=$authors_file --no-metadata -s $GIT_repository_name --trunk=/
 
cd $GIT_repository_name
 
# Moves the tags to be proper Git tags
git for-each-ref refs/remotes/tags | cut -d / -f 4- | grep -v @ | while read tagname; do git tag "$tagname" "tags/$tagname"; git branch -r -d "tags/$tagname"; done
 
# Moves the rest of the references under refs/remotes to be local branches
git for-each-ref refs/remotes | cut -d / -f 3- | grep -v @ | while read branchname; do git branch "$branchname" "refs/remotes/$branchname"; git branch -r -d "$branchname"; done
 
 
# Push the new GIT repository to the Git server
git remote add origin $GIT_repository_server
git push origin --all
git push origin --tags

Of course you will have to set the variables SVN_repository, GIT_repository_name and GIT_repository_server appropriately.

cedric's bazaar - gitlab:tips

api

Get the list of users registered in GitLab

Send an email to the members of a GitLab group

convert-subversion-to-git

Migrating a Subversion repository to Git on your GitLab instance