jenkins

Documentation

Index

• Variables
• type Build
  • func ParseBuildURL(buildURL string) (*Build, error)
  • func (b *Build) String() string
• type Client
  • func NewClient(logger *zap.Logger, serverURL, user, password string) (*Client, error)
  • func (s *Client) Build(ctx context.Context, j *Job) (int64, error)
  • func (s *Client) Do(req *http.Request) (*http.Response, error)
  • func (s *Client) GetBuildFromQueueItemID(ctx context.Context, queueItemID int64) (*Build, error)
  • func (s *Client) GetBuildURL(ctx context.Context, queueItemID int64) (string, error)
  • func (s *Client) String() string
• type Job
  • func (j *Job) String() string
• type JobTemplate
  • func (j *JobTemplate) Template(data TemplateData) (*Job, error)
• type TemplateData

Variables

var ErrBuildScheduled = errors.New("build scheduled, build not available yet")

Types

type Build

type Build struct {
	JobName string
	Number  int64
	// contains filtered or unexported fields
}

func ParseBuildURL

func ParseBuildURL(buildURL string) (*Build, error)

func (*Build) String

func (b *Build) String() string

type Client

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

Client is a HTTP API client for a Jenkins Server.

func NewClient

func NewClient(logger *zap.Logger, serverURL, user, password string) (*Client, error)

func (*Client) Build

func (s *Client) Build(ctx context.Context, j *Job) (int64, error)

Build schedules a build of the job. On success it returns the ID of the queued build item and nil. On errors where retrying might lead to positive result a goorderr.RetryableError is returned.

func (*Client) Do

func (s *Client) Do(req *http.Request) (*http.Response, error)

func (*Client) GetBuildFromQueueItemID

func (s *Client) GetBuildFromQueueItemID(ctx context.Context, queueItemID int64) (*Build, error)

GetBuildFromQueueItemID does the same than [s.GetBuildURL] but returns a Build instead of the URL as string.

func (*Client) GetBuildURL

func (s *Client) GetBuildURL(ctx context.Context, queueItemID int64) (string, error)

On errors where retrying might lead to positive result a goorderr.RetryableError is returned. This includes the case when a queued item exist but no build number has been assigned yet. A goorderr.RetryableError wrapping ErrBuildScheduled is returned.

The queued item URL expires 5 minutes after the item got a build number assigned and jenkins will responds with a 404 status code. The method will return an error.

func (*Client) String

func (s *Client) String() string

type Job

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

func (*Job) String

func (j *Job) String() string

type JobTemplate

type JobTemplate struct {
	RelURL     string
	Parameters map[string]string
}

JobTemplate is a Job definition that can contain Go-Template statements.

func (*JobTemplate) Template

func (j *JobTemplate) Template(data TemplateData) (*Job, error)

Template creates a concrete Job from j by templating it with [templateData] and [templateFuncs.

type TemplateData

type TemplateData struct {
	PullRequestNumber string
	Branch            string
}