externalplugins

Documentation

Overview

Package externalplugins provides the plugin help components to be compiled into external plugin binaries. Since external plugins only need to serve a "/help" endpoint this package just provides an http.HandlerFunc that wraps an ExternalPluginHelpProvider function.

Index

• func ServeExternalPluginHelp(mux *http.ServeMux, log *logrus.Entry, provider ExternalPluginHelpProvider)
• type ExternalPluginHelpProvider

Functions

func ServeExternalPluginHelp

func ServeExternalPluginHelp(mux *http.ServeMux, log *logrus.Entry, provider ExternalPluginHelpProvider)

ServeExternalPluginHelp returns a HandlerFunc that serves plugin help information that is provided by the specified ExternalPluginHelpProvider.

Types

type ExternalPluginHelpProvider

type ExternalPluginHelpProvider func(enabledRepos []string) (*pluginhelp.PluginHelp, error)

ExternalPluginHelpProvider is a func type that returns a PluginHelp struct for an external plugin based on the specified enabledRepos.