README
¶
stage: Create group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
Overview
This package consists of a set of packages that are responsible for executing a particular command/feature/operation. The full list of features can be viewed here. The commands implement the common interface:
type Command interface {
Execute(ctx context.Context) error
}
A command is executed by running the Execute method. The execution logic mostly shares the common pattern:
- Parse the arguments and validate them.
- Communicate with GitLab Rails using gitlabnet package. For example, it can be checking whether a client is authorized to execute this particular command or asking for a personal access token in order to return it to the client.
- If a command is related to Git operations, establish a connection with Gitaly using handler and gitaly packages and provide two-way communication between Gitaly and the client.
- Return results to the client.
This package is being used to build a particular command based on the passed arguments in the following files that are under cmd directory:
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CheckForVersionFlag ¶ added in v14.24.0
Types ¶
type LogMetadata ¶ added in v14.24.0
type LogMetadata struct {
Username string `json:"username"`
Project string `json:"project,omitempty"`
RootNamespace string `json:"root_namespace,omitempty"`
}
func NewLogMetadata ¶ added in v14.24.0
func NewLogMetadata(project, username string) LogMetadata
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.