jenkinsbee

Documentation

Overview

Package jenkinsbee is a Bee that can interface with a Jenkins server.

Index

• type JenkinsBee
  • func (mod *JenkinsBee) Action(action bees.Action) []bees.Placeholder
  • func (mod *JenkinsBee) ReloadOptions(options bees.BeeOptions)
  • func (mod *JenkinsBee) Run(cin chan bees.Event)
• type JenkinsBeeFactory
  • func (factory *JenkinsBeeFactory) Actions() []bees.ActionDescriptor
  • func (factory *JenkinsBeeFactory) Description() string
  • func (factory *JenkinsBeeFactory) Events() []bees.EventDescriptor
  • func (factory *JenkinsBeeFactory) ID() string
  • func (factory *JenkinsBeeFactory) Image() string
  • func (factory *JenkinsBeeFactory) LogoColor() string
  • func (factory *JenkinsBeeFactory) Name() string
  • func (factory *JenkinsBeeFactory) New(name, description string, options bees.BeeOptions) bees.BeeInterface
  • func (factory *JenkinsBeeFactory) Options() []bees.BeeOptionDescriptor
• type Job
• type LastBuild

Types

type JenkinsBee

type JenkinsBee struct {
	bees.Bee

	Jobs map[string]Job `json:"jobs"`
	// contains filtered or unexported fields
}

JenkinsBee is a Bee that can interface with a Jenkins server.

func (*JenkinsBee) Action

func (mod *JenkinsBee) Action(action bees.Action) []bees.Placeholder

Action triggers the action passed to it.

func (*JenkinsBee) ReloadOptions

func (mod *JenkinsBee) ReloadOptions(options bees.BeeOptions)

ReloadOptions parses the config options and initializes the Bee.

func (*JenkinsBee) Run

func (mod *JenkinsBee) Run(cin chan bees.Event)

Run executes the Bee's event loop.

type JenkinsBeeFactory

type JenkinsBeeFactory struct {
	bees.BeeFactory
}

JenkinsBeeFactory is a factory for JenkinsBees.

func (*JenkinsBeeFactory) Actions

func (factory *JenkinsBeeFactory) Actions() []bees.ActionDescriptor

Actions describes the available actions provided by this Bee.

func (*JenkinsBeeFactory) Description

func (factory *JenkinsBeeFactory) Description() string

Description returns the description of this Bee.

func (*JenkinsBeeFactory) Events

func (factory *JenkinsBeeFactory) Events() []bees.EventDescriptor

Events describes the available events provided by this Bee.

func (*JenkinsBeeFactory) ID

func (factory *JenkinsBeeFactory) ID() string

ID returns the ID of this Bee.

func (*JenkinsBeeFactory) Image

func (factory *JenkinsBeeFactory) Image() string

Image returns the filename of an image for this Bee.

func (*JenkinsBeeFactory) LogoColor

func (factory *JenkinsBeeFactory) LogoColor() string

LogoColor returns the preferred logo background color (used by the admin interface).

func (*JenkinsBeeFactory) Name

func (factory *JenkinsBeeFactory) Name() string

Name returns the name of this Bee.

func (*JenkinsBeeFactory) New

func (factory *JenkinsBeeFactory) New(name, description string, options bees.BeeOptions) bees.BeeInterface

New returns a new Bee instance configured with the supplied options.

func (*JenkinsBeeFactory) Options

func (factory *JenkinsBeeFactory) Options() []bees.BeeOptionDescriptor

Options returns the options available to configure this Bee.

type Job

type Job struct {
	Name      string    `json:"name"`
	URL       string    `json:"url"`
	Color     string    `json:"color"`
	LastBuild LastBuild `json:"lastBuild"`
}

Job represents the JSON API response for a Jenkins job.

type LastBuild

type LastBuild struct {
	Building bool `json:"building"`
}