shipshape_config_proto_go_src

Documentation

Overview

Package shipshape_config_proto_go_src is a generated protocol buffer package.

It is generated from these files:

shipshape/proto/shipshape_config.proto

It has these top-level messages:

GlobalConfig
EventConfig
ShipshapeConfig

Index

• type EventConfig
  • func (m *EventConfig) GetCategories() []string
  • func (m *EventConfig) GetEvent() string
  • func (*EventConfig) ProtoMessage()
  • func (m *EventConfig) Reset()
  • func (m *EventConfig) String() string
• type GlobalConfig
  • func (m *GlobalConfig) GetIgnore() []string
  • func (m *GlobalConfig) GetImages() []string
  • func (*GlobalConfig) ProtoMessage()
  • func (m *GlobalConfig) Reset()
  • func (m *GlobalConfig) String() string
• type ShipshapeConfig
  • func (m *ShipshapeConfig) GetEvents() []*EventConfig
  • func (m *ShipshapeConfig) GetGlobal() *GlobalConfig
  • func (*ShipshapeConfig) ProtoMessage()
  • func (m *ShipshapeConfig) Reset()
  • func (m *ShipshapeConfig) String() string

Types

type EventConfig

type EventConfig struct {
	// Defines points in a development workflow when one may want to run analyses
	// Pre-defined values used by Leeroy might include "Commit", "Review", and "Deploy".
	// A CLI might use "Developer". Jenkins without Leeroy might use all sorts of
	// events with job names like "Jenkins-Nightly", "Jenkins-QAGate", etc.
	// The special event "All" signals that this configuration applies to EVERY run of
	// Shipshape. If "All" is used, no other event can be used.
	// TODO(collinwinter): scrub internal Google codenames from this comment.
	Event *string `protobuf:"bytes,1,opt,name=event" json:"event,omitempty"`
	// A list of categories to run for this event. Each category must be found in
	// the default collection of analyzers, or in one of the analyzers listed in
	// the `images` list of the global section.
	Categories       []string `protobuf:"bytes,2,rep,name=categories" json:"categories,omitempty"`
	XXX_unrecognized []byte   `json:"-"`
}

func (*EventConfig) GetCategories

func (m *EventConfig) GetCategories() []string

func (*EventConfig) GetEvent

func (m *EventConfig) GetEvent() string

func (*EventConfig) ProtoMessage

func (*EventConfig) ProtoMessage()

func (*EventConfig) Reset

func (m *EventConfig) Reset()

func (*EventConfig) String

func (m *EventConfig) String() string

type GlobalConfig

type GlobalConfig struct {
	// URLs to third-party analyzers to be installed.
	// The URLs must point to a Docker image that can be downloaded and run.
	// The container must respond to the Shipshape RPC API on port 10005;
	// Shipshape will map this to a different external port.
	// For example,
	// gcr.io/shipshape_releases/android_lint:prod
	Images []string `protobuf:"bytes,1,rep,name=images" json:"images,omitempty"`
	// A list of subtrees to ignore when running analysis. Each entry in the list
	// is a directory, relative to the repository root.
	// TODO(collinwinter): add support for file=.gitignore syntax to avoid
	// duplication between multiple systems.
	Ignore           []string `protobuf:"bytes,2,rep,name=ignore" json:"ignore,omitempty"`
	XXX_unrecognized []byte   `json:"-"`
}

func (*GlobalConfig) GetIgnore

func (m *GlobalConfig) GetIgnore() []string

func (*GlobalConfig) GetImages

func (m *GlobalConfig) GetImages() []string

func (*GlobalConfig) ProtoMessage

func (*GlobalConfig) ProtoMessage()

func (*GlobalConfig) Reset

func (m *GlobalConfig) Reset()

func (*GlobalConfig) String

func (m *GlobalConfig) String() string

type ShipshapeConfig

type ShipshapeConfig struct {
	Global           *GlobalConfig  `protobuf:"bytes,1,opt,name=global" json:"global,omitempty"`
	Events           []*EventConfig `protobuf:"bytes,2,rep,name=events" json:"events,omitempty"`
	XXX_unrecognized []byte         `json:"-"`
}

Represents the Shipshape configuration.

func (*ShipshapeConfig) GetEvents

func (m *ShipshapeConfig) GetEvents() []*EventConfig

func (*ShipshapeConfig) GetGlobal

func (m *ShipshapeConfig) GetGlobal() *GlobalConfig

func (*ShipshapeConfig) ProtoMessage

func (*ShipshapeConfig) ProtoMessage()

func (*ShipshapeConfig) Reset

func (m *ShipshapeConfig) Reset()

func (*ShipshapeConfig) String

func (m *ShipshapeConfig) String() string