Repository files navigation

import"github.com/chefe/gitlabcodeowners"

Package gitlabcodeowners provides parsing and querying function to work with `CODEOWNERS` file from Gitlab. Seehttps://docs.gitlab.com/ee/user/project/codeowners for more details.

• func GetPossibleCodeOwnersLocations() []string
• type Approval
• type File
  • func NewCodeOwnersFile(reader io.Reader) (File, error)
  • func (f File) GetRequiredApprovalsForFile(path string) map[string]Approval
  • func (f File) GetRequiredApprovalsForFiles(paths []string) map[string][]Approval

funcGetPossibleCodeOwnersLocations() []string

GetPossibleCodeOwnersLocations returns a list of possible locations where a `CODEOWNERS` file can be located according to Gitlab.

Approval describes an approval required by a rule in the `CODEOWNERS` file.

typeApprovalstruct {PatternstringApprovalsintOwners    []string}

File is a representation of a parsed `CODEOWNERS` file.

typeFilestruct {// contains filtered or unexported fields}

funcNewCodeOwnersFile(reader io.Reader) (File,error)

NewCodeOwnersFile tries to parse the given description and returns a `File` instance if parsing succeeded otherwise it return an error.

func (fFile)GetRequiredApprovalsForFile(pathstring)map[string]Approval

GetRequiredApprovalsForFile returns a map of all approvals which apply to the file given by it's path. All path need to start with a `/` which represents the root folder of the repository.

func (fFile)GetRequiredApprovalsForFiles(paths []string)map[string][]Approval

GetRequiredApprovalsForFiles returns a map of all approvals which apply to the files given by their path. All paths need to start with a `/` which represents the root folder of the repository.

Generated bygomarkdoc