plugin

Documentation

Index

• func New(options ...func(*Plugin)) config.Plugin
• func WithAllowListFile(file string) func(*Plugin)
• func WithAlwaysRunAll(alwaysRunAll bool) func(*Plugin)
• func WithBitBucketAuthServer(bitBucketAuthServer string) func(*Plugin)
• func WithBitBucketClient(bitBucketClient string) func(*Plugin)
• func WithBitBucketSecret(bitBucketSecret string) func(*Plugin)
• func WithCacheTTL(ttl time.Duration) func(*Plugin)
• func WithConcat(concat bool) func(*Plugin)
• func WithConsiderFile(considerFile string) func(*Plugin)
• func WithFallback(fallback bool) func(*Plugin)
• func WithFinalizeSupport(finalize bool) func(*Plugin)
• func WithGithubToken(gitHubToken string) func(*Plugin)
• func WithGitlabServer(gitLabServer string) func(*Plugin)
• func WithGitlabToken(gitLabToken string) func(*Plugin)
• func WithMaxDepth(maxDepth int) func(*Plugin)
• func WithServer(server string) func(*Plugin)
• type ConsiderData
• type DroneConfigCombiner
  • func (dcc *DroneConfigCombiner) Append(ldc *LoadedDroneConfig)
  • func (dcc *DroneConfigCombiner) Combine(mondifyFinalizeConfig bool) string
  • func (dcc *DroneConfigCombiner) ConfigNames(without KeyOnlyMap) []string
  • func (dcc *DroneConfigCombiner) Merge(left *DroneConfigCombiner)
• type KeyOnlyMap
• type LoadedDroneConfig
• type Plugin
  • func (p *Plugin) Find(ctx context.Context, droneRequest *config.Request) (*drone.Config, error)
  • func (p *Plugin) NewScmClient(ctx context.Context, uuid uuid.UUID, repo drone.Repo) (scmClient scm_clients.ScmClient, err error)

Functions

func New

func New(options ...func(*Plugin)) config.Plugin

New creates a drone plugin

func WithAllowListFile

func WithAllowListFile(file string) func(*Plugin)

WithAllowListFile configures with repo slug regex match list file

func WithAlwaysRunAll

func WithAlwaysRunAll(alwaysRunAll bool) func(*Plugin)

WithAlwaysRunAll configures always run all enabled or disabled

func WithBitBucketAuthServer

func WithBitBucketAuthServer(bitBucketAuthServer string) func(*Plugin)

WithBitBucketAuthServer configures an auth server

func WithBitBucketClient

func WithBitBucketClient(bitBucketClient string) func(*Plugin)

WithBitBucketClient configures with a bitbucket client, alternative to github

func WithBitBucketSecret

func WithBitBucketSecret(bitBucketSecret string) func(*Plugin)

WithBitBucketClient configures with a bitbucket secret, alternative to github

func WithCacheTTL

func WithCacheTTL(ttl time.Duration) func(*Plugin)

WithCacheTTL enables request/response caching and the specified TTL for each entry

func WithConcat

func WithConcat(concat bool) func(*Plugin)

WithConcat configures with concat enabled or disabled

func WithConsiderFile

func WithConsiderFile(considerFile string) func(*Plugin)

WithConsiderFile configures with a consider file which contains references to all 'drone.yml' files which should be considered for the repository.

func WithFallback

func WithFallback(fallback bool) func(*Plugin)

WithFallback configures with fallback enabled or disabled

func WithFinalizeSupport

func WithFinalizeSupport(finalize bool) func(*Plugin)

WithFinalizeSupport adds dependencies to all pipelines to a user provider pipelined named `finalize`

func WithGithubToken

func WithGithubToken(gitHubToken string) func(*Plugin)

WithGithubToken configures with the github token specified

func WithGitlabServer

func WithGitlabServer(gitLabServer string) func(*Plugin)

WithGitlabServer configures with the gitlab server specified

func WithGitlabToken

func WithGitlabToken(gitLabToken string) func(*Plugin)

WithGitlabToken configures with the gitlab token specified

func WithMaxDepth

func WithMaxDepth(maxDepth int) func(*Plugin)

WithMaxDepth configures with max depth to search for 'drone.yml'. Requires fallback to be enabled.

func WithServer

func WithServer(server string) func(*Plugin)

WithServer configures with a custom SCM server

Types

type ConsiderData

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

ConsiderData holds the considerFile information in both list and map representations

type DroneConfigCombiner

type DroneConfigCombiner struct {
	LoadedConfigs []*LoadedDroneConfig
}

DroneConfigCombiner holds multiple LoadedDroneConfigs to combine them

func (*DroneConfigCombiner) Append

func (dcc *DroneConfigCombiner) Append(ldc *LoadedDroneConfig)

Append adds a new LoadedDroneConfig

func (*DroneConfigCombiner) Combine

func (dcc *DroneConfigCombiner) Combine(mondifyFinalizeConfig bool) string

Combine concats all appended configs in to a single string

func (*DroneConfigCombiner) ConfigNames

func (dcc *DroneConfigCombiner) ConfigNames(without KeyOnlyMap) []string

ConfigNames loads the names of all Pipelines as map keys

func (*DroneConfigCombiner) Merge

func (dcc *DroneConfigCombiner) Merge(left *DroneConfigCombiner)

Merge merges `left` into current DroneConfigCombiner

type KeyOnlyMap

type KeyOnlyMap map[string]interface{}

KeyOnlyMap is a map with only keys

type LoadedDroneConfig

type LoadedDroneConfig struct {
	Name    string
	Content string
}

LoadedDroneConfig holds the name and the string content of a `.drone.yml` file

type Plugin

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

Plugin defines the plugin settings

func (*Plugin) Find

func (p *Plugin) Find(ctx context.Context, droneRequest *config.Request) (*drone.Config, error)

Find is called by drone

func (*Plugin) NewScmClient

func (p *Plugin) NewScmClient(ctx context.Context, uuid uuid.UUID, repo drone.Repo) (scmClient scm_clients.ScmClient, err error)

NewScmClient creates a new client for the git provider