191 lines
5.4 KiB
Markdown
Vendored
191 lines
5.4 KiB
Markdown
Vendored
# go-gitlab
|
|
|
|
A GitLab API client enabling Go programs to interact with GitLab in a simple and uniform way
|
|
|
|
[](https://travis-ci.org/xanzy/go-gitlab)
|
|
[](https://github.com/xanzy/go-gitlab/blob/master/LICENSE)
|
|
[](https://sourcegraph.com/github.com/xanzy/go-gitlab?badge)
|
|
[](https://godoc.org/github.com/xanzy/go-gitlab)
|
|
[](https://goreportcard.com/report/github.com/xanzy/go-gitlab)
|
|
[](https://github.com/xanzy/go-gitlab/issues)
|
|
|
|
## NOTE
|
|
|
|
Release v0.6.0 (released on 25-08-2017) no longer supports the older V3 Gitlab API. If
|
|
you need V3 support, please use the `f-api-v3` branch. This release contains some backwards
|
|
incompatible changes that were needed to fully support the V4 Gitlab API.
|
|
|
|
## Coverage
|
|
|
|
This API client package covers most of the existing Gitlab API calls and is updated regularly
|
|
to add new and/or missing endpoints. Currently the following services are supported:
|
|
|
|
- [x] Applications
|
|
- [x] Award Emojis
|
|
- [x] Branches
|
|
- [x] Broadcast Messages
|
|
- [x] Commits
|
|
- [x] Container Registry
|
|
- [x] Custom Attributes
|
|
- [x] Deploy Keys
|
|
- [x] Deployments
|
|
- [ ] Discussions (threaded comments)
|
|
- [x] Environments
|
|
- [ ] Epic Issues
|
|
- [ ] Epics
|
|
- [x] Events
|
|
- [x] Feature Flags
|
|
- [ ] Geo Nodes
|
|
- [x] GitLab CI Config Templates
|
|
- [x] Gitignores Templates
|
|
- [x] Group Access Requests
|
|
- [x] Group Issue Boards
|
|
- [x] Group Members
|
|
- [x] Group Milestones
|
|
- [x] Group-Level Variables
|
|
- [x] Groups
|
|
- [x] Issue Boards
|
|
- [x] Issues
|
|
- [x] Jobs
|
|
- [x] Keys
|
|
- [x] Labels
|
|
- [x] License
|
|
- [x] Merge Request Approvals
|
|
- [x] Merge Requests
|
|
- [x] Namespaces
|
|
- [x] Notes (comments)
|
|
- [x] Notification Settings
|
|
- [x] Open Source License Templates
|
|
- [x] Pages Domains
|
|
- [x] Pipeline Schedules
|
|
- [x] Pipeline Triggers
|
|
- [x] Pipelines
|
|
- [x] Project Access Requests
|
|
- [x] Project Badges
|
|
- [x] Project Clusters
|
|
- [x] Project Import/export
|
|
- [x] Project Members
|
|
- [x] Project Milestones
|
|
- [x] Project Snippets
|
|
- [x] Project-Level Variables
|
|
- [x] Projects (including setting Webhooks)
|
|
- [x] Protected Branches
|
|
- [x] Protected Tags
|
|
- [x] Repositories
|
|
- [x] Repository Files
|
|
- [x] Runners
|
|
- [x] Search
|
|
- [x] Services
|
|
- [x] Settings
|
|
- [x] Sidekiq Metrics
|
|
- [x] System Hooks
|
|
- [x] Tags
|
|
- [x] Todos
|
|
- [x] Users
|
|
- [x] Validate CI Configuration
|
|
- [x] Version
|
|
- [x] Wikis
|
|
|
|
## 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, err := gitlab.NewClient("yourtokengoeshere")
|
|
if err != nil {
|
|
log.Fatalf("Failed to create client: %v", err)
|
|
}
|
|
users, _, err := git.Users.ListUsers(&gitlab.ListUsersOptions{})
|
|
```
|
|
|
|
There are a few `With...` option functions that can be used to customize
|
|
the API client. For example, to set a custom base URL:
|
|
|
|
```go
|
|
git, err := gitlab.NewClient("yourtokengoeshere", WithBaseURL("https://git.mydomain.com/api/v4"))
|
|
if err != nil {
|
|
log.Fatalf("Failed to create client: %v", err)
|
|
}
|
|
users, _, err := git.Users.ListUsers(&gitlab.ListUsersOptions{})
|
|
```
|
|
|
|
Some API methods have optional parameters that can be passed. For example,
|
|
to list all projects for user "svanharmelen":
|
|
|
|
```go
|
|
git := gitlab.NewClient("yourtokengoeshere")
|
|
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, err := gitlab.NewClient("yourtokengoeshere")
|
|
if err != nil {
|
|
log.Fatalf("Failed to create client: %v", err)
|
|
}
|
|
|
|
// 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),
|
|
Visibility: gitlab.Visibility(gitlab.PublicVisibility),
|
|
}
|
|
project, _, err := git.Projects.CreateProject(p)
|
|
if err != nil {
|
|
log.Fatal(err)
|
|
}
|
|
|
|
// Add a new snippet
|
|
s := &gitlab.CreateProjectSnippetOptions{
|
|
Title: gitlab.String("Dummy Snippet"),
|
|
FileName: gitlab.String("snippet.go"),
|
|
Code: gitlab.String("package main...."),
|
|
Visibility: gitlab.Visibility(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@vanharmelen.nl>)
|
|
|
|
## 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>
|