github

package

v0.0.0 Latest Latest Go to latest Published: Mar 9, 2023 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/zostay/zedpm

Links

Open Source Insights

Documentation ¶

Overview ¶

Package github provides shared tooling to allow zedpm plugins to interact with Github in a consistent way.

Index ¶

Constants
func GetPropertyGithubOwner(ctx context.Context) string
func GetPropertyGithubProject(ctx context.Context) string
func GetPropertyGithubReleaseName(ctx context.Context) (string, error)
func ReleaseBranch(ctx context.Context) (string, error)
func ReleaseDescription(ctx context.Context) string
func ReleaseTag(ctx context.Context) (string, error)
func TargetBranch(ctx context.Context) string
type Github

Constants ¶

View Source

const (
	PropertyGithubReleaseName = "github.release.name"
	PropertyGithubOwner       = "github.owner"
	PropertyGithubProject     = "github.projecct"
)

Variables ¶

This section is empty.

Functions ¶

func GetPropertyGithubOwner ¶

func GetPropertyGithubOwner(ctx context.Context) string

func GetPropertyGithubProject ¶

func GetPropertyGithubProject(ctx context.Context) string

func GetPropertyGithubReleaseName ¶

func GetPropertyGithubReleaseName(ctx context.Context) (string, error)

func ReleaseBranch ¶

func ReleaseBranch(ctx context.Context) (string, error)

func ReleaseDescription ¶

func ReleaseDescription(ctx context.Context) string

func ReleaseTag ¶

func ReleaseTag(ctx context.Context) (string, error)

func TargetBranch ¶

func TargetBranch(ctx context.Context) string

Types ¶

type Github ¶

type Github struct {
	git.Git
	// contains filtered or unexported fields
}

Github provides a client object for accessing the Github API.

func (*Github) Client ¶

func (g *Github) Client() *github.Client

func (*Github) OwnerProject ¶

func (g *Github) OwnerProject(ctx context.Context) (string, string, error)

func (*Github) SetupGithubClient ¶

func (g *Github) SetupGithubClient(ctx context.Context) error

Source Files ¶

View all Source files

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