webhook

Documentation

Index

• type Receiver
  • func NewReceiver(config ReceiverConfig, gitRepo domain.GitRepositoryRepository, ...) *Receiver
  • func (r *Receiver) Shutdown(ctx context.Context) error
  • func (r *Receiver) Start(_ context.Context) error
• type ReceiverConfig

Types

type Receiver

type Receiver struct {
	// contains filtered or unexported fields
}

Receiver is responsible for receiving webhook events and notifying repository refresh.

We should NOT trust the payload of webhooks, as they could be crafted and there is no secret. This behavior is inspired from ArgoCD Webhook behavior.

Cited from https://argo-cd.readthedocs.io/en/stable/operator-manual/webhook/

Configuring a webhook shared secret is optional, since Argo CD will still refresh applications
related to the Git repository, even with unauthenticated webhook events.
This is safe to do since the contents of webhook payloads are considered untrusted,
and will only result in a refresh of the application (a process which already occurs at three-minute intervals).

func NewReceiver

func NewReceiver(
	config ReceiverConfig,
	gitRepo domain.GitRepositoryRepository,
	fetcher repofetcher.Service,
	giteaIntegration domain.ControllerGiteaIntegrationService,
) *Receiver

func (*Receiver) Shutdown

func (r *Receiver) Shutdown(ctx context.Context) error

func (*Receiver) Start

func (r *Receiver) Start(_ context.Context) error

type ReceiverConfig

type ReceiverConfig struct {
	BasePath string `mapstructure:"basePath" yaml:"basePath"`
	Port     int    `mapstructure:"port" yaml:"port"`
}