config

Documentation

Index

• Constants
• Variables
• func SetConfig(c *Configuration)
• type Configuration
  • func GetConfig() *Configuration
  • func (c *Configuration) IsValid() error
  • func (c *Configuration) ProcessConfiguration() error

Constants

const (
	CommandPrefix = "circleci"

	URLPluginBase = "/plugins/" + PluginName
	URLStaticBase = URLPluginBase + "/static"

	HeaderMattermostUserID = "Mattermost-User-Id"

	BotUserName    = "circleci"
	BotDisplayName = "CircleCI"
	BotDescription = "Created by the CircleCI Plugin."

	BotIconURL        = URLStaticBase + "/circleci.png"
	BotThumbnail      = URLStaticBase + "/circleci-blue.png"
	BotIconURLSuccess = URLStaticBase + "/circleci_success.png"
	BotIconURLFailed  = URLStaticBase + "/circeci_failed.png"

	// TODO: Configurable retry count
	KVCompareAndSetMaxRetries = 5
)

const (
	PluginName = "com.mattermost.circleci"
)

Variables

var (
	Mattermost plugin.API
	BotUserID  string
)

Functions

func SetConfig

func SetConfig(c *Configuration)

Types

type Configuration

type Configuration struct {
	Secret        string `json:"Secret"`
	EncryptionKey string `json:"EncryptionKey"`
}

func GetConfig

func GetConfig() *Configuration

func (*Configuration) IsValid

func (c *Configuration) IsValid() error

IsValid is used for config validations.

func (*Configuration) ProcessConfiguration

func (c *Configuration) ProcessConfiguration() error

ProcessConfiguration is used for post-processing on configuration.