owners

Documentation

Index

• Constants
• type MemberInfo
• type MembersInfo
• type MembersResponse
• type Server
  • func (s *Server) ListOwners(org string, repo string, number int, config *tiexternalplugins.Configuration) (*ownersclient.OwnersResponse, error)
• type SigInfo
• type SigMembership
• type SigResponse

Constants

const (
	// SigEndpointFmt specifies a format for sigs URL.
	SigEndpointFmt = "/sigs/%s"
	// MembersEndpoint specifies a members endpoint.
	MembersEndpoint = "/members/"
)

Types

type MemberInfo

type MemberInfo struct {
	GithubName string `json:"githubName"`
	// Level specifies the level of contributor at this sig.
	Level string `json:"level,omitempty"`
}

MemberInfo specifies the contributor's github info.

type MembersInfo

type MembersInfo struct {
	Members []MemberInfo `json:"members,omitempty"`
	Total   int          `json:"total,omitempty"`
}

MembersInfo specifies the members info.

type MembersResponse

type MembersResponse struct {
	Data    MembersInfo `json:"data,omitempty"`
	Message string      `json:"message,omitempty"`
}

MembersResponse specifies the response to the request to get members.

type Server

type Server struct {
	// Client for get sig info.
	Client *http.Client

	TokenGenerator func() []byte
	Gc             githubClient
	ConfigAgent    *tiexternalplugins.ConfigAgent
	Log            *logrus.Entry
}

func (*Server) ListOwners

func (s *Server) ListOwners(org string, repo string, number int,
	config *tiexternalplugins.Configuration) (*ownersclient.OwnersResponse, error)

ListOwners returns owners of tidb community PR.

type SigInfo

type SigInfo struct {
	// Name specifies the name of sig.
	Name string `json:"name,omitempty"`
	// Membership specifies the membership of sig.
	Membership SigMembership `json:"membership,omitempty"`
	// Membership specifies the default required lgtm number of sig.
	NeedsLgtm int `json:"needsLGTM,omitempty"`
}

SigInfo specifies the sig info.

type SigMembership

type SigMembership struct {
	TechLeaders []MemberInfo `json:"techLeaders,omitempty"`
	CoLeaders   []MemberInfo `json:"coLeaders,omitempty"`
	Committers  []MemberInfo `json:"committers,omitempty"`
	Reviewers   []MemberInfo `json:"reviewers,omitempty"`
}

MemberInfo specifies the sig's membership.

type SigResponse

type SigResponse struct {
	Data    SigInfo `json:"data,omitempty"`
	Message string  `json:"message,omitempty"`
}

SigResponse specifies the response to the request to get owners.