link

Documentation

Index

• Constants
• type Code
• type CommitHashLink
• type Readme
  • func GetReadmeFromPath(ctx context.Context, client *query.Client, path string) (Readme, error)
  • func GetReadmePathFromChangedFiles(ctx context.Context, client *query.Client, files []string) (Readme, error)
  • func GetTspConfigFromPath(ctx context.Context, client *query.Client, path string) (Readme, error)
  • func GetTspConfigPathFromChangedFiles(ctx context.Context, client *query.Client, files []string) (Readme, error)
  • func (r Readme) IsMgmt() bool
  • func (r Readme) IsTsp() bool
• type ResolveResult
• type Resolver
  • func NewCommitLink(ctx context.Context, client *query.Client, requestLink, releaseLink string) Resolver
  • func NewDirectoryLink(ctx context.Context, client *query.Client, requestLink, releaseLink string) Resolver
  • func NewFileLink(ctx context.Context, client *query.Client, requestLink, releaseLink string) Resolver
  • func NewPullRequestLink(ctx context.Context, client *query.Client, requestLink, releaseLink string) Resolver

Constants

const (
	// SpecOwner ...
	SpecOwner = "Azure"
	// SpecRepo ...
	SpecRepo = "azure-rest-api-specs"
	// SpecRepoPrefix ...
	SpecRepoPrefix = "https://github.com/Azure/azure-rest-api-specs/"
	// PullRequestPrefix ...
	PullRequestPrefix = "pull/"
	// DirectoryPrefix ...
	DirectoryPrefix = "tree/"
	// FilePrefix ...
	FilePrefix = "blob/"
	// CommitPrefix ...
	CommitPrefix = "commit/"
	// SDKRepo ...
	SDKRepo = "azure-sdk-for-go"
	// ReleaseIssueRepo SDK Release Request Repo ...
	ReleaseIssueRepo = "sdk-release-request"
)

Types

type Code

type Code string

const (
	// CodeSuccess marks the resolve is successful
	CodeSuccess Code = "Success"
	// CodeDataPlane marks the resolved readme belongs to a data plane package
	CodeDataPlane Code = "DataPlaneRequest"
	// CodePRNotMerged marks the resolve succeeds but the requested PR is not merged yet
	CodePRNotMerged Code = "PRNotMerged"

	CodeTypeSpec Code = "TypeSpec"
)

type CommitHashLink

type CommitHashLink interface {
	GetCommitHash() (string, error)
}

CommitHashLink ...

type Readme

type Readme string

Readme represents a readme filepath

func GetReadmeFromPath

func GetReadmeFromPath(ctx context.Context, client *query.Client, path string) (Readme, error)

GetReadmeFromPath ...

func GetReadmePathFromChangedFiles

func GetReadmePathFromChangedFiles(ctx context.Context, client *query.Client, files []string) (Readme, error)

GetReadmePathFromChangedFiles ...

func GetTspConfigFromPath

func GetTspConfigFromPath(ctx context.Context, client *query.Client, path string) (Readme, error)

func GetTspConfigPathFromChangedFiles

func GetTspConfigPathFromChangedFiles(ctx context.Context, client *query.Client, files []string) (Readme, error)

GetTspConfigPathFromChangedFiles ...

func (Readme) IsMgmt

func (r Readme) IsMgmt() bool

IsMgmt returns true when the readme belongs to a mgmt plane package

func (Readme) IsTsp

func (r Readme) IsTsp() bool

type ResolveResult

type ResolveResult interface {
	GetReadme() Readme
	GetCode() Code
}

ResolveResult ...

type Resolver

type Resolver interface {
	GetReleaseLink() string
	GetRequestLink() string
	Resolve() (ResolveResult, error)
}

Resolver represent a readme path resolver which resolves a link and produces a readme path

func NewCommitLink

func NewCommitLink(ctx context.Context, client *query.Client, requestLink, releaseLink string) Resolver

NewCommitLink parses a commit link to its corresponding readme.md file link

func NewDirectoryLink

func NewDirectoryLink(ctx context.Context, client *query.Client, requestLink, releaseLink string) Resolver

NewDirectoryLink parses a directory link to its corresponding readme.md file link

func NewFileLink

func NewFileLink(ctx context.Context, client *query.Client, requestLink, releaseLink string) Resolver

NewFileLink parses a file link to its corresponding readme.md file link

func NewPullRequestLink

func NewPullRequestLink(ctx context.Context, client *query.Client, requestLink, releaseLink string) Resolver

NewPullRequestLink parses a pull request link to its corresponding readme.md file link