Documentation
¶
Overview ¶
Package gitlab provides access to GitLab via the official client-go SDK.
Index ¶
- type Client
- func (c *Client) CloseIssue(ctx context.Context, repo string, number int) error
- func (c *Client) ClosePR(ctx context.Context, repo string, number int) error
- func (c *Client) CommentIssue(ctx context.Context, repo string, number int, body string) error
- func (c *Client) CommentPR(ctx context.Context, repo string, number int, body string) error
- func (c *Client) CreateIssue(ctx context.Context, in operations.IssueInput) (operations.IssueDetail, error)
- func (c *Client) CreatePR(ctx context.Context, in operations.PRInput) (operations.PRDetail, error)
- func (c *Client) CreateRepo(ctx context.Context, in operations.RepoInput) (operations.Repo, error)
- func (c *Client) DeleteRepo(ctx context.Context, fullName string) error
- func (c *Client) FetchSpec(ctx context.Context, repo string, number int) (operations.FetchSpec, error)
- func (c *Client) GetIssue(ctx context.Context, repo string, number int) (operations.IssueDetail, error)
- func (c *Client) GetPR(ctx context.Context, repo string, number int) (operations.PRDetail, error)
- func (c *Client) ListIssues(ctx context.Context) ([]operations.Issue, error)
- func (c *Client) ListPRs(ctx context.Context) ([]operations.PR, error)
- func (c *Client) ListProjects(ctx context.Context) ([]operations.Project, error)
- func (c *Client) ListRepos(ctx context.Context) ([]operations.Repo, error)
- func (c *Client) ListRuns(ctx context.Context, fullName string) ([]operations.Run, error)
- func (c *Client) ListWorkflows(ctx context.Context, fullName string) ([]operations.Workflow, error)
- func (c *Client) MergePR(ctx context.Context, repo string, number int, opts operations.MergeOptions) error
- func (c *Client) Name() string
- func (c *Client) PRDiff(ctx context.Context, repo string, number int) (string, error)
- func (c *Client) RenameRepo(ctx context.Context, fullName, newName string) (operations.Repo, error)
- func (c *Client) SetForgeLabel(label string)
- func (c *Client) SetInstance(name string)
- func (c *Client) SetPRReady(ctx context.Context, repo string, number int, ready bool) error
- func (c *Client) SetVisibility(ctx context.Context, fullName string, private bool) (operations.Repo, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client talks to the GitLab API on behalf of the authenticated user.
func New ¶
func New(cfg operations.GitLabConfig) (*Client, error)
New builds a GitLab client from the given credentials. When cfg.URL is set (self-hosted instance), it is used as the API base URL; /api/v4 is appended automatically when missing.
func (*Client) CloseIssue ¶
CloseIssue closes an issue.
func (*Client) CommentIssue ¶
CommentIssue adds a note to an issue.
func (*Client) CreateIssue ¶
func (c *Client) CreateIssue(ctx context.Context, in operations.IssueInput) (operations.IssueDetail, error)
CreateIssue opens a new issue.
func (*Client) CreatePR ¶
func (c *Client) CreatePR(ctx context.Context, in operations.PRInput) (operations.PRDetail, error)
CreatePR opens a merge request.
func (*Client) CreateRepo ¶
func (c *Client) CreateRepo(ctx context.Context, in operations.RepoInput) (operations.Repo, error)
CreateRepo creates a project. GitLab projects live in the authenticated user's namespace unless in.Owner names a group, in which case the group's projects API is used.
func (*Client) DeleteRepo ¶
DeleteRepo deletes a project. fullName is namespace/path.
func (*Client) FetchSpec ¶
func (c *Client) FetchSpec(ctx context.Context, repo string, number int) (operations.FetchSpec, error)
FetchSpec returns how to fetch a merge request head locally.
GitLab publishes every merge request head under refs/merge-requests/N/head, which also exists for fork merge requests.
func (*Client) GetIssue ¶
func (c *Client) GetIssue(ctx context.Context, repo string, number int) (operations.IssueDetail, error)
GetIssue returns a single issue in full.
func (*Client) ListIssues ¶
ListIssues returns open issues assigned to the authenticated user.
func (*Client) ListProjects ¶
ListProjects lists projects, which on GitLab are the repositories.
func (*Client) ListWorkflows ¶
ListWorkflows returns ErrNotSupported: GitLab has no workflow-definition concept; its pipelines are surfaced by ListRuns.
func (*Client) MergePR ¶
func (c *Client) MergePR(ctx context.Context, repo string, number int, opts operations.MergeOptions) error
MergePR merges a merge request.
GitLab does not accept a merge strategy per request: the merge method is a project setting (merge commit, fast-forward or rebase). Only squash can be requested per merge, so that is the only method acted on here; the others fall back to whatever the project is configured to do.
func (*Client) RenameRepo ¶
RenameRepo renames a project. fullName is namespace/path.
func (*Client) SetForgeLabel ¶
SetForgeLabel overrides the forge label the client stamps on returned resources. Used to give user-named aliases the right identity in listings while the GitLab client does the API work.
func (*Client) SetInstance ¶
SetInstance names this client's instance (default: the forge type).
func (*Client) SetPRReady ¶
SetPRReady toggles a merge request between draft and ready.
GitLab models the draft state as a "Draft:" prefix on the title rather than as a settable flag, so the title is rewritten. This is the same approach glab takes, and it keeps working on self-hosted versions that predate the draft field on the API.
func (*Client) SetVisibility ¶
func (c *Client) SetVisibility(ctx context.Context, fullName string, private bool) (operations.Repo, error)
SetVisibility changes a project's visibility. fullName is namespace/path.