codeowners

Documentation

Index

• type CodeOwners
  • func Get(ctx context.Context, cl *github.Client, owner string, repo string) (CodeOwners, error)
  • func (co CodeOwners) Match(ctx context.Context, path string) (users []*github.User, errorSlices []error)
  • func (co CodeOwners) String() string

Types

type CodeOwners

type CodeOwners struct {
	// contains filtered or unexported fields
}

this struct holds the description of a whole codeowners file

func Get

func Get(ctx context.Context, cl *github.Client, owner string, repo string) (CodeOwners, error)

Get is the "entrypoint" where a codeOwners struct is returned for calling Match on

func (CodeOwners) Match

func (co CodeOwners) Match(ctx context.Context, path string) (users []*github.User, errorSlices []error)

Match a file to some github users (or email addresses) called on a codeOwners struct

func (CodeOwners) String

func (co CodeOwners) String() string

format a codeOwners struct back into a string