terraform/vendor/github.com/xanzy/go-gitlab
Richard Clamp 1a21a388f5 vendor: bring in github.com/xanzy/go-gitlab 0.5.1
Add go-gitlab as a dependency for the gitlab provider
2017-04-21 12:53:22 +01:00
..
CHANGELOG.md vendor: bring in github.com/xanzy/go-gitlab 0.5.1 2017-04-21 12:53:22 +01:00
LICENSE vendor: bring in github.com/xanzy/go-gitlab 0.5.1 2017-04-21 12:53:22 +01:00
README.md vendor: bring in github.com/xanzy/go-gitlab 0.5.1 2017-04-21 12:53:22 +01:00
branches.go vendor: bring in github.com/xanzy/go-gitlab 0.5.1 2017-04-21 12:53:22 +01:00
build_variables.go vendor: bring in github.com/xanzy/go-gitlab 0.5.1 2017-04-21 12:53:22 +01:00
builds.go vendor: bring in github.com/xanzy/go-gitlab 0.5.1 2017-04-21 12:53:22 +01:00
commits.go vendor: bring in github.com/xanzy/go-gitlab 0.5.1 2017-04-21 12:53:22 +01:00
deploy_keys.go vendor: bring in github.com/xanzy/go-gitlab 0.5.1 2017-04-21 12:53:22 +01:00
events.go vendor: bring in github.com/xanzy/go-gitlab 0.5.1 2017-04-21 12:53:22 +01:00
gitlab.go vendor: bring in github.com/xanzy/go-gitlab 0.5.1 2017-04-21 12:53:22 +01:00
groups.go vendor: bring in github.com/xanzy/go-gitlab 0.5.1 2017-04-21 12:53:22 +01:00
issues.go vendor: bring in github.com/xanzy/go-gitlab 0.5.1 2017-04-21 12:53:22 +01:00
labels.go vendor: bring in github.com/xanzy/go-gitlab 0.5.1 2017-04-21 12:53:22 +01:00
merge_requests.go vendor: bring in github.com/xanzy/go-gitlab 0.5.1 2017-04-21 12:53:22 +01:00
milestones.go vendor: bring in github.com/xanzy/go-gitlab 0.5.1 2017-04-21 12:53:22 +01:00
namespaces.go vendor: bring in github.com/xanzy/go-gitlab 0.5.1 2017-04-21 12:53:22 +01:00
notes.go vendor: bring in github.com/xanzy/go-gitlab 0.5.1 2017-04-21 12:53:22 +01:00
notifications.go vendor: bring in github.com/xanzy/go-gitlab 0.5.1 2017-04-21 12:53:22 +01:00
pipelines.go vendor: bring in github.com/xanzy/go-gitlab 0.5.1 2017-04-21 12:53:22 +01:00
project_snippets.go vendor: bring in github.com/xanzy/go-gitlab 0.5.1 2017-04-21 12:53:22 +01:00
projects.go vendor: bring in github.com/xanzy/go-gitlab 0.5.1 2017-04-21 12:53:22 +01:00
repositories.go vendor: bring in github.com/xanzy/go-gitlab 0.5.1 2017-04-21 12:53:22 +01:00
repository_files.go vendor: bring in github.com/xanzy/go-gitlab 0.5.1 2017-04-21 12:53:22 +01:00
services.go vendor: bring in github.com/xanzy/go-gitlab 0.5.1 2017-04-21 12:53:22 +01:00
session.go vendor: bring in github.com/xanzy/go-gitlab 0.5.1 2017-04-21 12:53:22 +01:00
settings.go vendor: bring in github.com/xanzy/go-gitlab 0.5.1 2017-04-21 12:53:22 +01:00
strings.go vendor: bring in github.com/xanzy/go-gitlab 0.5.1 2017-04-21 12:53:22 +01:00
system_hooks.go vendor: bring in github.com/xanzy/go-gitlab 0.5.1 2017-04-21 12:53:22 +01:00
tags.go vendor: bring in github.com/xanzy/go-gitlab 0.5.1 2017-04-21 12:53:22 +01:00
time_stats.go vendor: bring in github.com/xanzy/go-gitlab 0.5.1 2017-04-21 12:53:22 +01:00
users.go vendor: bring in github.com/xanzy/go-gitlab 0.5.1 2017-04-21 12:53:22 +01:00

README.md

go-gitlab

A GitLab API client enabling Go programs to interact with GitLab in a simple and uniform way

Documentation: GoDoc Build Status: Build Status

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:

  • 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
  • Pipelines

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: gitlab.String("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:                 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.

ToDo

  • The biggest thing this package still needs is tests 😞

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