github

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)
• type Github
  • func (g *Github) Client() *github.Client
  • func (g *Github) OwnerProject(ctx context.Context) (string, string, error)
  • func (g *Github) SetupGithubClient(ctx context.Context) error

Constants

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

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)

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