builds

Documentation

Overview

Package builds is a package for sending build requests to the Bugsnag Build API, as defined here: https://bugsnagbuildapi.docs.apiary.io/

Index

• type JSONBuildRequest
  • func (r *JSONBuildRequest) Validate() error
• type JSONSourceControl
• type Publisher
  • func DefaultPublisher() *Publisher
  • func NewPublisher(endpoint string) *Publisher
  • func (p *Publisher) Publish(req *JSONBuildRequest) error

Types

type JSONBuildRequest

type JSONBuildRequest struct {
	// The notifier API key of the project.
	APIKey string `json:"apiKey"` // E.g. "1234abcd1234abcd1234abcd1234abcd"

	// The version number of the application.
	// This is used to identify the particular version of the application that
	// the build relates to.
	AppVersion string `json:"appVersion"` // E.g. "1.5.2"

	// The release stage (eg, production, staging) that is being released (if
	// applicable). Normally the fact that a build has been released to a
	// release stage is detected automatically when an error event or session is
	// received for the build. However if you would like to manually notify
	// Bugsnag of the build being released you can specify the stage that the
	// build was released to.
	ReleaseStage string `json:"releaseStage,omitempty"` // E.g. "staging"

	// The name of the entity that triggered the build. Could be a user,
	// system, etc.
	BuilderName string `json:"builderName,omitempty"` // E.g. "River Tam"

	// Key value pairs containing any custom build information that provides
	// useful metadata about the build. e.g. build configuration parameters,
	// versions of dependencies, reason for the build etc.
	Metadata map[string]string `json:"metadata,omitempty"` // E.g. map[string]string{"buildServer": "build1", "buildReason": "Releasing JIRA-1234"}

	// Information about the source control of the code. This can be used to
	// link errors to the source code (for supported source control tools)
	SourceControl *JSONSourceControl `json:"sourceControl,omitempty"`

	// The version code of the application (Android only).
	// For Android apps if no code is provided Bugsnag will associate the build
	// information with the most recent build for the app version.
	AppVersionCode int `json:"appVersionCode,omitempty"` // E.g. 1234

	// The bundle version/build number of the application (iOS/macOS/tvOS only).
	// For iOS/macOS/tvOS apps if no bundle version is provided we will
	// associate the build information with the most recent build for the app
	// version.
	AppBundleVersion string `json:"appBundleVersion,omitempty"` // E.g. "1.2.3"

	// Flag indicating whether to automatically associate this build with any
	// new error events and sessions that are received for the releaseStage
	// until a subsequent build notification is received for the release stage
	// If this is set to true and no releaseStage is provided the build will be
	// applied to production. Automatically assigning builds to new error
	// events is generally discouraged as it can result events from previous
	// builds being incorrectly recorded against a new build while builds are
	// being rolled out.
	AutoAssignRelease bool `json:"autoAssignRelease,omitempty"`
}

JSONBuildRequest defines the complete request body to Bugsnag's build API as defined here: https://bugsnagbuildapi.docs.apiary.io/#introduction/matching-error-events-and-sessions-to-builds

func (*JSONBuildRequest) Validate

func (r *JSONBuildRequest) Validate() error

Validate checks that the given JSONBuildRequest is valid. If it is not valid, an error is returned.

type JSONSourceControl

type JSONSourceControl struct {
	// If the provider can be inferred from the repository then it is not
	// required. Must be one of: "github", "github-enterprise", "bitbucket",
	// "bitbucket-server", "gitlab", or "gitlab-onpremise".
	Provider string `json:"provider,omitempty"`

	// Repository represents the URL of the repository containing the source
	// code being deployed.
	Repository string `json:"repository"`

	// Revision is the source control SHA-1 hash for the code that has been
	// built (short or long hash).
	Revision string `json:"revision"`
}

JSONSourceControl is information about the source control of the code. This can be used to link errors to the source code (for supported source control tools)

type Publisher

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

Publisher is a type for sending build requests to the Bugsnag Build API, as defined here: https://bugsnagbuildapi.docs.apiary.io/

func DefaultPublisher

func DefaultPublisher() *Publisher

DefaultPublisher returns a publisher for requests against the Bugsnag SaaS endpoint. If you need to target your own on-premise installation, please use NewPublisher.

func NewPublisher

func NewPublisher(endpoint string) *Publisher

NewPublisher returns a publisher for requests against an on-premise installation of Bugsnag. If you're using the SaaS solution (app.bugsnag.com), please use the DefaultPublisher.

func (*Publisher) Publish

func (p *Publisher) Publish(req *JSONBuildRequest) error

Publish sends the request to Bugsnag's Build API.