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(project, branch string) bool
• func FindProject(project string) (*gitlab.Project, error)
• func Fork(project string) (string, error)
• func GetMR(project string, mrNum int) (*gitlab.MergeRequest, error)
• func Host() string
• func Init()
• 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 ListMRs(project string, opts *gitlab.ListProjectMergeRequestsOptions) ([]*gitlab.MergeRequest, error)
• func LoadGitLabTmpl(tmplName string) string
• func MergeRequest(project string, opts *gitlab.CreateMergeRequestOptions) (string, 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(project, 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 GetMR

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

GetMR retrieves the merge request from GitLab project

func Host

func Host() string

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

func Init

func Init()

Init handles all of the credential setup and prompts for user input when not present. At the end it initializes a gitlab client for use throughout lab.

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 ListMRs

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

ListMRs lists the MRs on a GitLab project

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 MergeRequest

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

MergeRequest opens a merge request on GitLab

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