mirror of https://github.com/strongdm/comply synced 2024-11-25 09:04:54 +00:00

Justin McCarthy 7468711b3b

Releases after github.com/xanzy/go-gitlab@v0.31.0 introduce breaking
changes to the NewClient call.

Addresses #94

2020-09-14 11:31:56 -07:00

5.0 KiB

Raw Blame History

go-gitlab

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

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 := gitlab.NewClient(nil, "yourtokengoeshere")
//git.SetBaseURL("https://git.mydomain.com/api/v4")
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(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),
		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

If you have an issue: report it on the issue tracker

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

5.0 KiB Raw Blame History