models

Documentation

Index

• type Checks
• type ChecksParams
  • func (p *ChecksParams) String() string
• type Commit
• type CountParams
• type PullRequest
• type PullRequestGeneratorParams
• type PullRequestParams
  • func (p *PullRequestParams) String() string
• type Run
• type Status

Types

type Checks

type Checks struct {
	HeadCommit *string
	Runs       []Run
	Statuses   []Status
}

type ChecksParams

type ChecksParams struct {
	params.Default

	Owner      string `json:"owner" query:"owner" validate:"required"`
	Repository string `json:"repository" query:"repository" validate:"required"`
	Ref        string `json:"ref" query:"ref" validate:"required"`
}

func (*ChecksParams) String

func (p *ChecksParams) String() string

Used by cache as identifier

type Commit

type Commit struct {
	SHA    string
	Author models.Author
}

type CountParams

type CountParams struct {
	params.Default

	Query string `json:"query" query:"query" validate:"required"`
}

type PullRequest

type PullRequest struct {
	ID     int
	Title  string
	Author coreModels.Author

	SourceOwner      string
	SourceRepository string
	SourceBranch     string
	CommitSHA        string
}

type PullRequestGeneratorParams

type PullRequestGeneratorParams struct {
	params.Default

	Owner      string `json:"owner" query:"owner" validate:"required"`
	Repository string `json:"repository" query:"repository" validate:"required"`
}

type PullRequestParams

type PullRequestParams struct {
	params.Default

	Owner      string `json:"owner" query:"owner" validate:"required"`
	Repository string `json:"repository" query:"repository" validate:"required"`
	ID         *int   `json:"id" query:"id" validate:"required"`
}

func (*PullRequestParams) String

func (p *PullRequestParams) String() string

Used by cache as identifier

type Run

type Run struct {
	ID          int64
	Title       string
	Status      string // queued, in_progress, or completed
	Conclusion  string // success, failure, neutral, cancelled, timed_out, or action_required
	StartedAt   *time.Time
	CompletedAt *time.Time
}

Run represents GitHub Action Data See : https://developer.github.com/v3/checks/runs/

type Status

type Status struct {
	ID        int64
	Title     string
	State     string // error, success, failure, or pending
	CreatedAt time.Time
	UpdatedAt time.Time
}

Status Represent Simple "Status" provided by Apps (CodeCov, Travis ...) See : https://developer.github.com/v3/repos/statuses/