tasks

Documentation

Index

• Variables
• func CalculateChangeLeadTime(taskCtx plugin.SubTaskContext) errors.Error
• func ConnectIncidentToDeployment(taskCtx plugin.SubTaskContext) errors.Error
• func EnrichPrevSuccessDeploymentCommit(taskCtx plugin.SubTaskContext) errors.Error
• func EnrichTasksEnv(taskCtx plugin.SubTaskContext) (err errors.Error)
• func GenerateDeploymentCommits(taskCtx plugin.SubTaskContext) errors.Error
• type DoraApiParams
• type DoraOptions
  • func DecodeAndValidateTaskOptions(options map[string]interface{}) (*DoraOptions, errors.Error)
• type DoraTaskData

Variables

var CalculateChangeLeadTimeMeta = plugin.SubTaskMeta{
	Name:             "calculateChangeLeadTime",
	EntryPoint:       CalculateChangeLeadTime,
	EnabledByDefault: true,
	Description:      "Calculate change lead time",
	DomainTypes:      []string{plugin.DOMAIN_TYPE_CICD, plugin.DOMAIN_TYPE_CODE},
}

CalculateChangeLeadTimeMeta contains metadata for the CalculateChangeLeadTime subtask.

var ConnectIncidentToDeploymentMeta = plugin.SubTaskMeta{
	Name:             "ConnectIncidentToDeployment",
	EntryPoint:       ConnectIncidentToDeployment,
	EnabledByDefault: true,
	Description:      "Connect incident issue to deployment",
	DomainTypes:      []string{plugin.DOMAIN_TYPE_CICD},
}

var DeploymentCommitsGeneratorMeta = plugin.SubTaskMeta{
	Name:             "generateDeploymentCommits",
	EntryPoint:       GenerateDeploymentCommits,
	EnabledByDefault: false,
	Description:      "Generate deployment_commits from cicd_pipeline_commits if cicd_pipeline.type == DEPLOYMENT or any of its cicd_tasks is a deployment task",
	DomainTypes:      []string{plugin.DOMAIN_TYPE_CICD},
}

var EnrichPrevSuccessDeploymentCommitMeta = plugin.SubTaskMeta{
	Name:             "enrichPrevSuccessDeploymentCommits",
	EntryPoint:       EnrichPrevSuccessDeploymentCommit,
	EnabledByDefault: false,
	Description:      "filling the prev_success_deployment_commit_id for cicd_deployment_commits table",
	DomainTypes:      []string{plugin.DOMAIN_TYPE_CODE},
}

var EnrichTaskEnvMeta = plugin.SubTaskMeta{
	Name:             "EnrichTaskEnv",
	EntryPoint:       EnrichTasksEnv,
	EnabledByDefault: false,
	Description:      "calculate deployment frequency",
	DomainTypes:      []string{plugin.DOMAIN_TYPE_CICD},
}

EnrichTaskEnvMeta will be removed in v0.17 DEPRECATED

Functions

func CalculateChangeLeadTime

func CalculateChangeLeadTime(taskCtx plugin.SubTaskContext) errors.Error

CalculateChangeLeadTime calculates change lead time for a project.

func ConnectIncidentToDeployment

func ConnectIncidentToDeployment(taskCtx plugin.SubTaskContext) errors.Error

func EnrichPrevSuccessDeploymentCommit

func EnrichPrevSuccessDeploymentCommit(taskCtx plugin.SubTaskContext) errors.Error

EnrichPrevSuccessDeploymentCommit Please note that deploying multiple environment (such as TESTING) copies (such as testing1 and testing2) using multiple steps with Deployment tools like Bitbucket or Gitlab is not supported and may result in incorrect outcomes. It is recommended that you deploy all copies in a single step. We arrived at this decision because we believe that deploying multiple environment copies using multiple steps is not a common or reasonable practice. However, if you have strong evidence to suggest otherwise, you are free to file an issue on our GitHub repository.

func EnrichTasksEnv

func EnrichTasksEnv(taskCtx plugin.SubTaskContext) (err errors.Error)

func GenerateDeploymentCommits

func GenerateDeploymentCommits(taskCtx plugin.SubTaskContext) errors.Error

Types

type DoraApiParams

type DoraApiParams struct {
	ProjectName string
}

type DoraOptions

type DoraOptions struct {
	Tasks       []string `json:"tasks,omitempty"`
	Since       string
	ProjectName string `json:"projectName"`
}

func DecodeAndValidateTaskOptions

func DecodeAndValidateTaskOptions(options map[string]interface{}) (*DoraOptions, errors.Error)

type DoraTaskData

type DoraTaskData struct {
	Options *DoraOptions
}