Documentation ¶
Index ¶
Constants ¶
View Source
const ( // Default name of file containing the pipeline definition DefaultPipeControlFileName = "generate.yaml" // Default name of the generated pipeline config.yml DefaultPipeOutFile = "generated_config.yml" // default name for the generated workflow DefaultPipeWorkflowName = "continuation-generated-workflow" // Include an approval step between pro and post jobs or after, or none DefaultPipeApproveAfterPre = true DefaultPipeApproveAfterPost = false DefaultPipeIsApprove = true // Should jobs require the prior approval step, usually set to match PipeIsApprove DefaultPipePriorJobsRequired = true // Skip approval step for this role DefaultPipeSkipApproval = "" // Include Pre or Post jobs DefaultPipeIsPre = true DefaultPipeIsPost = true // Should there be Pre or Post jobs for each role rather than each instance DefaultPipePreRoleOnly = false DefaultPipePostRoleOnly = false // Default names for pre, approve, and post job template files DefaultPipePreTemplate = "pre-approve.yml" DefaultPipePostTemplate = "post-approve.yml" // Default names for pre, approve, and post jobs DefaultPipePreJobName = "plan %s change" DefaultPipePostJobName = "apply %s change" DefaultPipeApprovalJobName = "approve %s changes" // Generate environment setting json files DefaultEnvFilesCreate = true // Default folder for environment setting files DefaultEnvFilesPath = "environments" // Default extension for environment setting files // the files will be json format regardless of this setting DefaultEnvFilesExt = ".json" // Default name DefaultEnvDefaultsFileName = "default" DefaultEnvFilesWriteExt = ".tfvars.json" // Advanced configuration options, not typically used // Approval template is defined within the cli by default but can override by setting to file reference DefaultPipeWorkflowHeading = "default" DefaultPipeApprovalTemplate = "default" DefaultPipePath = ".circleci" DefaultCircleciConfigFile = "config.yml" // settings for cli configuration file ConfigEnvDefault = "CIRCLEPIPE" ConfigFileDefaultName = ".circlepipe" ConfigFileDefaultType = "yaml" ConfigFileDefaultLocation = "." ConfigFileDefaultLocationMsg = "config file (default is ./.circlepipe.yaml)" )
circlepipe default settings
View Source
const ( DefaultWorkflowHeading = ` workflows: version: 2 %s: jobs: ` DefaultApproval = ` - {{.jobname}}: type: approval {{.jobstobeapproved}} filters: {{.filter}} ` )
Variables ¶
View Source
var CircleciConfigFile string
View Source
var EnvDefaultsFileName string
View Source
var EnvFilesCreate bool
View Source
var EnvFilesExt string
View Source
var EnvFilesPath string
View Source
var EnvFilesWriteExt string
View Source
var PipeApprovalJobName string
View Source
var PipeApprovalTemplate string
View Source
var PipeApproveAfterPost bool
View Source
var PipeApproveAfterPre bool
View Source
var PipeControlFileName string
View Source
var PipeIsApprove bool
View Source
var PipeIsPost bool
View Source
var PipeIsPre bool
View Source
var PipeOutFile string
View Source
var PipePath string
View Source
var PipePostJobName string
View Source
var PipePostRoleOnly bool
View Source
var PipePostTemplate string
View Source
var PipePreJobName string
View Source
var PipePreRoleOnly bool
View Source
var PipePreTemplate string
View Source
var PipePriorJobsRequired bool
View Source
var PipeSkipApproval string
View Source
var PipeWorkflowHeading string
View Source
var PipeWorkflowName string
View Source
var Version = "snapshot"
Functions ¶
Types ¶
type PipelineMap ¶
func (*PipelineMap) NewFromFile ¶
func (p *PipelineMap) NewFromFile(fqfn string) error
Click to show internal directories.
Click to hide internal directories.