gh

Documentation

Index

• Constants
• func PushUsingLocalGit(ctx context.Context, gitRoot string, addPaths []string, message string) error
• type ArtifactFile
• type Gh
  • func New() (*Gh, error)
  • func (g *Gh) Client() *github.Client
  • func (g *Gh) DetectCurrentBranch(ctx context.Context) (string, error)
  • func (g *Gh) DetectCurrentJobID(ctx context.Context, owner, repo string) (int64, error)
  • func (g *Gh) DetectCurrentPullRequestNumber(ctx context.Context, owner, repo string) (int, error)
  • func (g *Gh) GetDefaultBranch(ctx context.Context, owner, repo string) (string, error)
  • func (g *Gh) GetLatestArtifact(ctx context.Context, owner, repo, name, fp string) (*ArtifactFile, error)
  • func (g *Gh) GetPullRequestFiles(ctx context.Context, owner, repo string, number int) ([]*PullRequestFile, error)
  • func (g *Gh) GetRawRootURL(ctx context.Context, owner, repo string) (string, error)
  • func (g *Gh) GetStepByTime(ctx context.Context, owner, repo string, jobID int64, t time.Time) (Step, error)
  • func (g *Gh) GetStepExecutionTimeByTime(ctx context.Context, owner, repo string, jobID int64, t time.Time) (time.Duration, error)
  • func (g *Gh) GetStepsByName(ctx context.Context, owner, repo string, name string) ([]Step, error)
  • func (g *Gh) PushContent(ctx context.Context, owner, repo, branch, content, cp, message string) error
  • func (g *Gh) PutArtifact(ctx context.Context, name, fp string, content []byte) error
  • func (g *Gh) PutComment(ctx context.Context, owner, repo string, n int, comment string) error
  • func (g *Gh) PutCommentWithDeletion(ctx context.Context, owner, repo string, n int, comment string) error
  • func (g *Gh) SetClient(client *github.Client)
• type GitHubEvent
  • func DecodeGitHubEvent() (*GitHubEvent, error)
• type PullRequestFile
• type Repository
  • func Parse(raw string) (*Repository, error)
  • func (r *Repository) Reponame() string
• type Step

Constants

const DefaultGithubServerURL = "https://github.com"

Functions

func PushUsingLocalGit

func PushUsingLocalGit(ctx context.Context, gitRoot string, addPaths []string, message string) error

Types

type ArtifactFile

type ArtifactFile struct {
	Name      string
	Content   []byte
	CreatedAt time.Time
}

type Gh

type Gh struct {
	// contains filtered or unexported fields
}

func New

func New() (*Gh, error)

func (*Gh) Client

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

func (*Gh) DetectCurrentBranch

func (g *Gh) DetectCurrentBranch(ctx context.Context) (string, error)

func (*Gh) DetectCurrentJobID

func (g *Gh) DetectCurrentJobID(ctx context.Context, owner, repo string) (int64, error)

func (*Gh) DetectCurrentPullRequestNumber

func (g *Gh) DetectCurrentPullRequestNumber(ctx context.Context, owner, repo string) (int, error)

func (*Gh) GetDefaultBranch

func (g *Gh) GetDefaultBranch(ctx context.Context, owner, repo string) (string, error)

func (*Gh) GetLatestArtifact

func (g *Gh) GetLatestArtifact(ctx context.Context, owner, repo, name, fp string) (*ArtifactFile, error)

func (*Gh) GetPullRequestFiles

func (g *Gh) GetPullRequestFiles(ctx context.Context, owner, repo string, number int) ([]*PullRequestFile, error)

func (*Gh) GetRawRootURL

func (g *Gh) GetRawRootURL(ctx context.Context, owner, repo string) (string, error)

func (*Gh) GetStepByTime

func (g *Gh) GetStepByTime(ctx context.Context, owner, repo string, jobID int64, t time.Time) (Step, error)

func (*Gh) GetStepExecutionTimeByTime

func (g *Gh) GetStepExecutionTimeByTime(ctx context.Context, owner, repo string, jobID int64, t time.Time) (time.Duration, error)

func (*Gh) GetStepsByName

func (g *Gh) GetStepsByName(ctx context.Context, owner, repo string, name string) ([]Step, error)

func (*Gh) PushContent

func (g *Gh) PushContent(ctx context.Context, owner, repo, branch, content, cp, message string) error

func (*Gh) PutArtifact

func (g *Gh) PutArtifact(ctx context.Context, name, fp string, content []byte) error

func (*Gh) PutComment

func (g *Gh) PutComment(ctx context.Context, owner, repo string, n int, comment string) error

func (*Gh) PutCommentWithDeletion

func (g *Gh) PutCommentWithDeletion(ctx context.Context, owner, repo string, n int, comment string) error

func (*Gh) SetClient

func (g *Gh) SetClient(client *github.Client)

type GitHubEvent

type GitHubEvent struct {
	Name    string
	Number  int
	State   string
	Payload interface{}
}

func DecodeGitHubEvent

func DecodeGitHubEvent() (*GitHubEvent, error)

type PullRequestFile

type PullRequestFile struct {
	Filename string
	BlobURL  string
}

type Repository

type Repository struct {
	Owner string
	Repo  string
	Path  string
}

func Parse

func Parse(raw string) (*Repository, error)

func (*Repository) Reponame

func (r *Repository) Reponame() string

type Step

type Step struct {
	Name        string
	StartedAt   time.Time
	CompletedAt time.Time
}