link

package

v0.0.0-...-113f7ca Latest Latest Go to latest Published: May 4, 2024 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/Azure/azure-sdk-for-go

Links

Open Source Insights

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 (r Readme) IsMgmt() bool
type ResolveResult
type Resolver

Constants ¶

View Source

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"
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

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"
)

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 (Readme) IsMgmt ¶

func (r Readme) IsMgmt() bool

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

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

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL