go-gitlab
A GitLab API client enabling Go programs to interact with GitLab in a simple and uniform way
Coverage
This API client package covers 100% of the existing GitLab API calls! So this includes all calls to the following services:
- Users
- Session
- Projects (including setting Webhooks)
- Project Snippets
- Services
- Repositories
- Repository Files
- Commits
- Branches
- Merge Requests
- Issues
- Labels
- Milestones
- Notes (comments)
- Deploy Keys
- System Hooks
- Groups
- Namespaces
- Settings
Usage
import "github.com/xanzy/go-gitlab"
Construct a new GitLab client, then use the various services on the client to access different parts of the GitLab API. For example, to list all users:
git := gitlab.NewClient(nil, "yourtokengoeshere")
//git.SetBaseURL("https://git.mydomain.com/api/v3")
users, _, err := git.Users.ListUsers()
Some API methods have optional parameters that can be passed. For example, to list all projects for user "svanharmelen":
git := gitlab.NewClient(nil)
opt := &ListProjectsOptions{Search: "svanharmelen"})
projects, _, err := git.Projects.ListProjects(opt)
Examples
The examples directory contains a couple for clear examples, of which one is partially listed here as well:
package main
import (
"log"
"github.com/xanzy/go-gitlab"
)
func main() {
git := gitlab.NewClient(nil, "yourtokengoeshere")
// Create new project
p := &gitlab.CreateProjectOptions{
Name: "My Project",
Description: "Just a test project to play with",
MergeRequestsEnabled: true,
SnippetsEnabled: true,
VisibilityLevel: gitlab.PublicVisibility,
}
project, _, err := git.Projects.CreateProject(p)
if err != nil {
log.Fatal(err)
}
// Add a new snippet
s := &gitlab.CreateSnippetOptions{
Title: "Dummy Snippet",
FileName: "snippet.go",
Code: "package main....",
VisibilityLevel: gitlab.PublicVisibility,
}
_, _, err = git.ProjectSnippets.CreateSnippet(project.ID, s)
if err != nil {
log.Fatal(err)
}
}
For complete usage of go-gitlab, see the full package docs.
ToDo
- The biggest thing this package still needs is tests 😞
Issues
- If you have an issue: report it on the issue tracker
Author
Sander van Harmelen (sander@xanzy.io)
License
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0