Documentation
¶
Index ¶
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Codeowner ¶
type Codeowner struct {
Pattern string
Owners []string
Section string // gitlab code owners file has section
// contains filtered or unexported fields
}
Codeowner - owners for a given pattern
func NewCodeowner ¶
NewCodeowner -
type Codeowners ¶
type Codeowners struct {
Patterns []Codeowner
// contains filtered or unexported fields
}
Codeowners - patterns/owners mappings for the given repo
func FromFile ¶
func FromFile(path string) (*Codeowners, error)
FromFile creates a Codeowners from the path to a local file. Consider using FromFileWithFS instead.
Example ¶
c, _ := FromFile(testDir()) fmt.Println(c.Patterns[0])
Output: * bridgecrewio
func FromFileWithFS ¶
func FromFileWithFS(fsys fs.FS, path string) (*Codeowners, error)
FromFileWithFS creates a Codeowners from the path to a file relative to the given filesystem.
Example ¶
// open filesystem rooted at current working directory fsys := os.DirFS(testDir()) c, _ := FromFileWithFS(fsys, ".") fmt.Println(c.Patterns[0])
Output: * bridgecrewio
func FromReader ¶
func FromReader(r io.Reader, repoRoot string) (*Codeowners, error)
FromReader creates a Codeowners from a given Reader instance and root path.
Example ¶
reader := strings.NewReader(sample2) c, _ := FromReader(reader, "") fmt.Println(c.Patterns[0])
Output: * @hairyhenderson
func NewSingleCodeOwners ¶
func NewSingleCodeOwners(path string) (*Codeowners, error)
func (*Codeowners) Owners ¶
func (c *Codeowners) Owners(path string) []string
Owners - return the list of code owners for the given path (within the repo root)
Example ¶
c, _ := FromFile(testDir())
owners := c.Owners("README.md")
for i, o := range owners {
fmt.Printf("Owner #%d is %s\n", i, o)
}
Output: Owner #0 is bridgecrewio
func (*Codeowners) Section ¶
func (c *Codeowners) Section(path string) string
Section - return the section of code owners for the given path (within the repo root)
Source Files
Click to show internal directories.
Click to hide internal directories.