remotedetect

Documentation

Index

• type Platform
  • func DetectPlatform(ctx context.Context, dir string, cfg *config.Config) (Platform, error)
  • func (p Platform) String() string
• type ReviewContext
  • func ResolveReviewContext(ctx context.Context, dir string) (ReviewContext, error)
  • func ResolveReviewContextWithBranch(ctx context.Context, dir string, headBranch string) (ReviewContext, error)

Types

type Platform

type Platform int

const (
	PlatformUnknown Platform = iota
	PlatformGitHub
	PlatformGitLab
)

func DetectPlatform

func DetectPlatform(ctx context.Context, dir string, cfg *config.Config) (Platform, error)

func (Platform) String

func (p Platform) String() string

type ReviewContext

type ReviewContext struct {
	Platform   Platform
	RemoteName string
	RemoteURL  string
	Review     domain.ReviewRef
}

func ResolveReviewContext

func ResolveReviewContext(ctx context.Context, dir string) (ReviewContext, error)

func ResolveReviewContextWithBranch

func ResolveReviewContextWithBranch(ctx context.Context, dir string, headBranch string) (ReviewContext, error)

ResolveReviewContextWithBranch resolves remotes and platform from dir, using the provided headBranch instead of running git branch --show-current. This is necessary for bare repos where --show-current always fails.