gitlab

Documentation

Overview

Package gitlab is an internal wrapper for the go-gitlab package

Most functions serve to expose debug logging if set and accept a project name string over an ID

Index

• Constants
• Variables
• func BranchPushed(pid interface{}, branch string) bool
• func FindProject(project string) (*gitlab.Project, error)
• func Fork(project string) (string, error)
• func Host() string
• func Init(_host, _user, _token string)
• func IssueClose(pid interface{}, id int) error
• func IssueCreate(project string, opts *gitlab.CreateIssueOptions) (string, error)
• func IssueGet(project string, issueNum int) (*gitlab.Issue, error)
• func IssueList(project string, opts *gitlab.ListProjectIssuesOptions) ([]*gitlab.Issue, error)
• func Lint(content string) (bool, error)
• func LoadGitLabTmpl(tmplName string) string
• func MRClose(pid interface{}, id int) error
• func MRCreate(project string, opts *gitlab.CreateMergeRequestOptions) (string, error)
• func MRGet(project string, mrNum int) (*gitlab.MergeRequest, error)
• func MRList(project string, opts *gitlab.ListProjectMergeRequestsOptions) ([]*gitlab.MergeRequest, error)
• func MRMerge(pid interface{}, id int) error
• func ProjectSnippetCreate(pid interface{}, opts *gitlab.CreateProjectSnippetOptions) (*gitlab.Snippet, error)
• func ProjectSnippetDelete(pid interface{}, id int) error
• func ProjectSnippetList(pid interface{}, opts *gitlab.ListProjectSnippetsOptions) ([]*gitlab.Snippet, error)
• func SnippetCreate(opts *gitlab.CreateSnippetOptions) (*gitlab.Snippet, error)
• func SnippetDelete(id int) error
• func SnippetList(opts *gitlab.ListSnippetsOptions) ([]*gitlab.Snippet, error)
• func User() string

Constants

const (
	TmplMR    = "merge_request_templates/default.md"
	TmplIssue = "issue_templates/default.md"
)

Defines filepath for default GitLab templates

Variables

var (
	ErrProjectNotFound = errors.New("gitlab project not found")
)

Functions

func BranchPushed

func BranchPushed(pid interface{}, branch string) bool

BranchPushed checks if a branch exists on a GitLab project

func FindProject

func FindProject(project string) (*gitlab.Project, error)

FindProject looks up the Gitlab project. If the namespace is not provided in the project string it will search for projects in the users namespace

func Fork

func Fork(project string) (string, error)

Fork creates a user fork of a GitLab project

func Host

func Host() string

Host exposes the GitLab scheme://hostname used to interact with the API

func Init

func Init(_host, _user, _token string)

Init initializes a gitlab client for use throughout lab.

func IssueClose

func IssueClose(pid interface{}, id int) error

IssueClose closes an issue on a GitLab project

func IssueCreate

func IssueCreate(project string, opts *gitlab.CreateIssueOptions) (string, error)

IssueCreate opens a new issue on a GitLab Project

func IssueGet

func IssueGet(project string, issueNum int) (*gitlab.Issue, error)

IssueGet retrieves the issue information from a GitLab project

func IssueList

func IssueList(project string, opts *gitlab.ListProjectIssuesOptions) ([]*gitlab.Issue, error)

IssueList gets a list of issues on a GitLab Project

func Lint

func Lint(content string) (bool, error)

Lint validates .gitlab-ci.yml contents

func LoadGitLabTmpl

func LoadGitLabTmpl(tmplName string) string

LoadGitLabTmpl loads gitlab templates for use in creating Issues and MRs

https://gitlab.com/help/user/project/description_templates.md#setting-a-default-template-for-issues-and-merge-requests

func MRClose

func MRClose(pid interface{}, id int) error

MRClose closes an mr on a GitLab project

func MRCreate

func MRCreate(project string, opts *gitlab.CreateMergeRequestOptions) (string, error)

MRCreate opens a merge request on GitLab

func MRGet

func MRGet(project string, mrNum int) (*gitlab.MergeRequest, error)

MRGet retrieves the merge request from GitLab project

func MRList

func MRList(project string, opts *gitlab.ListProjectMergeRequestsOptions) ([]*gitlab.MergeRequest, error)

MRList lists the MRs on a GitLab project

func MRMerge

func MRMerge(pid interface{}, id int) error

MRMerge merges an mr on a GitLab project

func ProjectSnippetCreate

func ProjectSnippetCreate(pid interface{}, opts *gitlab.CreateProjectSnippetOptions) (*gitlab.Snippet, error)

ProjectSnippetCreate creates a snippet in a project

func ProjectSnippetDelete

func ProjectSnippetDelete(pid interface{}, id int) error

ProjectSnippetDelete deletes a project snippet

func ProjectSnippetList

func ProjectSnippetList(pid interface{}, opts *gitlab.ListProjectSnippetsOptions) ([]*gitlab.Snippet, error)

ProjectSnippetList lists snippets on a project

func SnippetCreate

func SnippetCreate(opts *gitlab.CreateSnippetOptions) (*gitlab.Snippet, error)

SnippetCreate creates a personal snippet

func SnippetDelete

func SnippetDelete(id int) error

SnippetDelete deletes a personal snippet

func SnippetList

func SnippetList(opts *gitlab.ListSnippetsOptions) ([]*gitlab.Snippet, error)

SnippetList lists snippets on a project

func User

func User() string

User exposes the configured GitLab user