bitrise

Documentation

Index

• type Annotation
• type App
• type AppOwner
• type AppResponse
• type Build
• type Client
  • func NewClient(apiToken string) *Client
  • func NewClientWithTimeout(apiToken string, timeout time.Duration) *Client
  • func (c *Client) CreateLintStepResult(appSlug string, buildSlug string, lsr *LintStepResult) error
  • func (c *Client) CreateTestStepResult(appSlug string, buildSlug string, tsr *TestStepResult) error
  • func (c *Client) GetApp(appSlug string) (App, error)
  • func (c *Client) GetBuildOfApp(buildSlug string, appSlug string) (*http.Response, *Build, error)
  • func (c *Client) GetLatestBuildOfApp(appSlug string) (*Build, error)
  • func (c *Client) RegisterWebhook(app *models.App) (*http.Response, error)
• type LintStepResult
• type StepResult
• type TestStepResult

Types

type Annotation

type Annotation struct {
	Path            string `json:"path"`
	StartLine       int    `json:"start_line"`
	EndLine         int    `json:"end_line"`
	StartColumn     int    `json:"start_column"`
	EndColumn       int    `json:"end_column"`
	AnnotationLevel string `json:"annotation_level"`
	Message         string `json:"message"`
	Title           string `json:"title"`
	RawDetails      string `json:"raw_details"`
}

Annotation ...

type App

type App struct {
	Owner                 AppOwner `json:"owner"`
	IsGitHubChecksEnabled bool     `json:"is_github_checks_enabled"`
	Slug                  string   `json:"slug"`
}

App represents an app

type AppOwner

type AppOwner struct {
	AccountType string `json:"account_type"`
	Name        string `json:"name"`
	Slug        string `json:"slug"`
}

AppOwner represents an app owner

type AppResponse

type AppResponse struct {
	Data App `json:"data"`
}

AppResponse represents an app response as returned by Bitrise API

type Build

type Build struct {
	Status int    `json:"status"`
	Slug   string `json:"slug"`
}

Build represents a build

type Client

type Client struct {
	BaseURL string
	// contains filtered or unexported fields
}

Client manages communication with the Bitrise API.

func NewClient

func NewClient(apiToken string) *Client

NewClient returns a new instance of *Client.

func NewClientWithTimeout

func NewClientWithTimeout(apiToken string, timeout time.Duration) *Client

NewClientWithTimeout returns a new instance of *Client with the given timeout.

func (*Client) CreateLintStepResult

func (c *Client) CreateLintStepResult(appSlug string, buildSlug string, lsr *LintStepResult) error

CreateLintStepResult creates a new test step result

func (*Client) CreateTestStepResult

func (c *Client) CreateTestStepResult(appSlug string, buildSlug string, tsr *TestStepResult) error

CreateTestStepResult creates a new test step result

func (*Client) GetApp

func (c *Client) GetApp(appSlug string) (App, error)

GetApp fetches an app from Bitrise API

func (*Client) GetBuildOfApp

func (c *Client) GetBuildOfApp(buildSlug string, appSlug string) (*http.Response, *Build, error)

GetBuildOfApp returns information about a single build.

func (*Client) GetLatestBuildOfApp

func (c *Client) GetLatestBuildOfApp(appSlug string) (*Build, error)

GetLatestBuildOfApp returns information about the latest build of app.

func (*Client) RegisterWebhook

func (c *Client) RegisterWebhook(app *models.App) (*http.Response, error)

RegisterWebhook ...

type LintStepResult

type LintStepResult struct {
	StepResult
	Annotations []Annotation `json:"annotations"`
}

LintStepResult ...

type StepResult

type StepResult struct {
	Name   string `json:"name"`
	Status string `json:"status"`
}

StepResult ...

type TestStepResult

type TestStepResult struct {
	StepResult
	Total       int                `json:"total"`
	FailedTests []junitparser.Test `json:"failed_tests"`
}

TestStepResult ...