126 lines
3.3 KiB
Markdown
126 lines
3.3 KiB
Markdown
# go-gitlab
|
|
|
|
A GitLab API client enabling Go programs to interact with GitLab in a simple and uniform way
|
|
|
|
**Documentation:** [](https://godoc.org/github.com/xanzy/go-gitlab)
|
|
**Build Status:** [](https://travis-ci.org/xanzy/go-gitlab)
|
|
|
|
## NOTE
|
|
|
|
Release v0.5.0 (released on 22-03-2017) no longer supports Go versions older
|
|
then 1.7.x If you want (or need) to use an older Go version please use v0.4.1
|
|
|
|
## Coverage
|
|
|
|
This API client package covers **100%** of the existing GitLab API calls! So this
|
|
includes all calls to the following services:
|
|
|
|
- [x] Users
|
|
- [x] Session
|
|
- [x] Projects (including setting Webhooks)
|
|
- [x] Project Snippets
|
|
- [x] Services
|
|
- [x] Repositories
|
|
- [x] Repository Files
|
|
- [x] Commits
|
|
- [x] Branches
|
|
- [x] Merge Requests
|
|
- [x] Issues
|
|
- [x] Labels
|
|
- [x] Milestones
|
|
- [x] Notes (comments)
|
|
- [x] Deploy Keys
|
|
- [x] System Hooks
|
|
- [x] Groups
|
|
- [x] Namespaces
|
|
- [x] Settings
|
|
- [x] Pipelines
|
|
|
|
## Usage
|
|
|
|
```go
|
|
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:
|
|
|
|
```go
|
|
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":
|
|
|
|
```go
|
|
git := gitlab.NewClient(nil)
|
|
opt := &ListProjectsOptions{Search: gitlab.String("svanharmelen")})
|
|
projects, _, err := git.Projects.ListProjects(opt)
|
|
```
|
|
|
|
### Examples
|
|
|
|
The [examples](https://github.com/xanzy/go-gitlab/tree/master/examples) directory
|
|
contains a couple for clear examples, of which one is partially listed here as well:
|
|
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"log"
|
|
|
|
"github.com/xanzy/go-gitlab"
|
|
)
|
|
|
|
func main() {
|
|
git := gitlab.NewClient(nil, "yourtokengoeshere")
|
|
|
|
// Create new project
|
|
p := &gitlab.CreateProjectOptions{
|
|
Name: gitlab.String("My Project"),
|
|
Description: gitlab.String("Just a test project to play with"),
|
|
MergeRequestsEnabled: gitlab.Bool(true),
|
|
SnippetsEnabled: gitlab.Bool(true),
|
|
VisibilityLevel: gitlab.VisibilityLevel(gitlab.PublicVisibility),
|
|
}
|
|
project, _, err := git.Projects.CreateProject(p)
|
|
if err != nil {
|
|
log.Fatal(err)
|
|
}
|
|
|
|
// Add a new snippet
|
|
s := &gitlab.CreateSnippetOptions{
|
|
Title: gitlab.String("Dummy Snippet"),
|
|
FileName: gitlab.String("snippet.go"),
|
|
Code: gitlab.String("package main...."),
|
|
VisibilityLevel: gitlab.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](https://godoc.org/github.com/xanzy/go-gitlab).
|
|
|
|
## ToDo
|
|
|
|
- The biggest thing this package still needs is tests :disappointed:
|
|
|
|
## Issues
|
|
|
|
- If you have an issue: report it on the [issue tracker](https://github.com/xanzy/go-gitlab/issues)
|
|
|
|
## 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>
|