You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
6543 82dbb34c9c
Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136)
* vendor update: go-gitlab to v0.31.0

* migrate client init to v0.31.0

* refactor
4 years ago
..
.gitignore Add support for migrating from Gitlab (#9084) 4 years ago
.travis.yml Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
CHANGELOG.md Add support for migrating from Gitlab (#9084) 4 years ago
LICENSE Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
README.md Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
access_requests.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
applications.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
award_emojis.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
boards.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
branches.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
broadcast_messages.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
ci_yml_templates.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
client_options.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
commits.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
custom_attributes.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
deploy_keys.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
deploy_tokens.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
deployments.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
discussions.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
environments.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
epics.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
event_parsing.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
event_systemhook_types.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
event_webhook_types.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
events.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
feature_flags.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
gitignore_templates.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
gitlab.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
go.mod Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
go.sum Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
group_badges.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
group_boards.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
group_clusters.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
group_hooks.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
group_labels.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
group_members.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
group_milestones.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
group_variables.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
groups.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
issue_links.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
issues.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
jobs.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
keys.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
labels.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
license.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
license_templates.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
merge_request_approvals.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
merge_requests.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
milestones.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
namespaces.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
notes.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
notifications.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
pages_domains.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
pipeline_schedules.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
pipeline_triggers.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
pipelines.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
project_badges.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
project_clusters.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
project_import_export.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
project_members.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
project_snippets.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
project_variables.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
projects.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
protected_branches.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
protected_tags.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
registry.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
releaselinks.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
releases.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
repositories.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
repository_files.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
request_options.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
resource_label_events.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
runners.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
search.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
services.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
settings.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
sidekiq_metrics.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
snippets.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
strings.go Add support for migrating from Gitlab (#9084) 4 years ago
system_hooks.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
tags.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
time_stats.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
todos.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
users.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
validate.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago
version.go Add support for migrating from Gitlab (#9084) 4 years ago
wikis.go Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 4 years ago

README.md

go-gitlab

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

Build Status GitHub license Sourcegraph GoDoc Go Report Card GitHub 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:

  • Applications
  • Award Emojis
  • Branches
  • Broadcast Messages
  • Commits
  • Container Registry
  • Custom Attributes
  • Deploy Keys
  • Deployments
  • Discussions (threaded comments)
  • Environments
  • Epic Issues
  • Epics
  • Events
  • Feature Flags
  • Geo Nodes
  • GitLab CI Config Templates
  • Gitignores Templates
  • Group Access Requests
  • Group Issue Boards
  • Group Members
  • Group Milestones
  • Group-Level Variables
  • Groups
  • Issue Boards
  • Issues
  • Jobs
  • Keys
  • Labels
  • License
  • Merge Request Approvals
  • Merge Requests
  • Namespaces
  • Notes (comments)
  • Notification Settings
  • Open Source License Templates
  • Pages Domains
  • Pipeline Schedules
  • Pipeline Triggers
  • Pipelines
  • Project Access Requests
  • Project Badges
  • Project Clusters
  • Project Import/export
  • Project Members
  • Project Milestones
  • Project Snippets
  • Project-Level Variables
  • Projects (including setting Webhooks)
  • Protected Branches
  • Protected Tags
  • Repositories
  • Repository Files
  • Runners
  • Search
  • Services
  • Settings
  • Sidekiq Metrics
  • System Hooks
  • Tags
  • Todos
  • Users
  • Validate CI Configuration
  • Version
  • Wikis

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, 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:

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":

git := gitlab.NewClient("yourtokengoeshere")
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, 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.

ToDo

  • The biggest thing this package still needs is tests 😞

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