plugin

Documentation

Index

• Variables
• type PluginBase
• type PluginSignature
• type Ref
• type ValidationComment
  • func Check(archiveURL string, schemaPath string, client *grafana.Client) (json.RawMessage, []ValidationComment, error)

Variables

var ErrInvalidPullRequest = errors.New("invalid pull request")

ErrInvalidPullRequest is returned whenever a URL or commit couldn't be determined from a diff.

var ErrPluginNotFound = errors.New("plugin not found")

ErrPluginNotFound is returned whenever a plugin could be found for a given ref.

Types

type PluginBase

type PluginBase struct {
	ID        string
	PluginDir string
	Version   string
}

type PluginSignature

type PluginSignature int

const (
	PluginSignatureUnsigned PluginSignature = iota
	PluginSignatureInvalid
	PluginSignatureModified
	PluginSignatureValid
)

type Ref

type Ref struct {
	Username string `json:"username"`
	Repo     string `json:"repo"`
	Ref      string `json:"ref"`
}

Ref describes a plugin version on GitHub.

type ValidationComment

type ValidationComment struct {
	Severity checkSeverity `json:"level"`
	Message  string        `json:"message"`
	Details  string        `json:"details"`
}

ValidationComment contains a comment returned by one of the checkers.

func Check

func Check(archiveURL string, schemaPath string, client *grafana.Client) (json.RawMessage, []ValidationComment, error)

Check executes a number of checks to validate a plugin.