webhook

package

v1.5.0 Latest Latest Go to latest Published: Apr 21, 2017 License: Apache-2.0 Imports: 8 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/tangle329/origin

Links

Open Source Insights

Documentation ¶

Overview ¶

Package webhook contains code for managing and serving webhook services, providing post push events to trigger builds.

Index ¶

Constants
Variables
func FindTriggerPolicy(triggerType buildapi.BuildTriggerType, config *buildapi.BuildConfig) (buildTriggers []buildapi.BuildTriggerPolicy, err error)
func GitRefMatches(eventRef, configRef string, buildSource *buildapi.BuildSource) bool
func NewWarning(message string) *kerrors.StatusError
func ValidateWebHookSecret(webHookTriggers []buildapi.BuildTriggerPolicy, secret string) (*buildapi.WebHookTrigger, error)
type Plugin

Constants ¶

View Source

const (
	DefaultConfigRef = "master"
)

Variables ¶

View Source

var (
	ErrSecretMismatch  = errors.New("the provided secret does not match")
	ErrHookNotEnabled  = errors.New("the specified hook is not enabled")
	MethodNotSupported = errors.New("unsupported HTTP method")
)

Functions ¶

func FindTriggerPolicy ¶ added in v0.2.1

func FindTriggerPolicy(triggerType buildapi.BuildTriggerType, config *buildapi.BuildConfig) (buildTriggers []buildapi.BuildTriggerPolicy, err error)

FindTriggerPolicy retrieves the BuildTrigger of a given type from a build configuration

func GitRefMatches ¶ added in v0.2.1

func GitRefMatches(eventRef, configRef string, buildSource *buildapi.BuildSource) bool

GitRefMatches determines if the ref from a webhook event matches a build configuration

func NewWarning ¶ added in v1.4.0

func NewWarning(message string) *kerrors.StatusError

NewWarning returns an StatusError object with a http.StatusOK (200) code.

func ValidateWebHookSecret ¶ added in v1.3.0

func ValidateWebHookSecret(webHookTriggers []buildapi.BuildTriggerPolicy, secret string) (*buildapi.WebHookTrigger, error)

ValidateWebHookSecret validates the provided secret against all currently defined webhook secrets and if it is valid, returns its information.

Types ¶

type Plugin ¶

type Plugin interface {
	// Method extracts build information and returns:
	// - newly created build object or nil if default is to be created
	// - information whether to trigger the build itself
	// - eventual error.
	Extract(buildCfg *buildapi.BuildConfig, secret, path string, req *http.Request) (*buildapi.SourceRevision, []kapi.EnvVar, bool, error)
}

Plugin for Webhook verification is dependent on the sending side, it can be eg. github, bitbucket or else, so there must be a separate Plugin instance for each webhook provider.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
generic Package generic contains webhook.Plugin implementation of a generic webhooks for use in testing and/or other ad/hoc usage	Package generic contains webhook.Plugin implementation of a generic webhooks for use in testing and/or other ad/hoc usage
github Package github contains webhook.Plugin implementation of github webhooks according to https://developer.github.com/webhooks/	Package github contains webhook.Plugin implementation of github webhooks according to https://developer.github.com/webhooks/

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL