CumulusCI Config

cumulusci.yml file for configuring CumulusCI, a Salesforce automation framework

Type object
File match cumulusci.yml
Schema URL https://catalog.lintel.tools/schemas/schemastore/cumulusci-config/latest.json
Source https://raw.githubusercontent.com/SFDO-Tooling/CumulusCI/main/cumulusci/schema/cumulusci.jsonschema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

tasks Record<string, object>
Default:
{}
flows Record<string, object>
Default:
{}
project
Default:
{}
All of: Project object
orgs
Default:
{}
All of: Orgs object
services Record<string, object>
Default:
{}
cumulusci object
1 nested properties
keychain string required
plans Record<string, object>
Default:
{}
minimum_cumulusci_version string
sources Record<string, LocalFolderSourceModel | GitHubSourceModel>
Default:
{}
cli object
2 nested properties
show_stacktraces boolean
Default: false
plain_output boolean

Definitions

Task object
class_path string
description string
group string
options object
Default:
{}
ui_options object
Default:
{}
name string
PreflightCheck object
when string
action string
message string
Step object
task string
flow string
ignore_failure boolean
Default: false
when string
options object
Default:
{}
ui_options object
Default:
{}
checks PreflightCheck[]
Default:
[]
description string
Flow object
description string
steps Record<string, object>
group string
Package object
name string
name_managed string
namespace string
install_class string
uninstall_class string
api_version string
metadata_package_id string
Test object
name_match string required
ReleaseNotesParser object
class_path string required
title string required
ReleaseNotes object
parsers Record<string, object> required
Git object
repo_url string
default_branch string
prefix_feature string
prefix_beta string
prefix_release string
push_prefix_sandbox string
push_prefix_production string
release_notes object
1 nested properties
parsers Record<string, object> required
2gp_context string
unlocked_context string
DependencyResolutions object
production string
preproduction string
resolution_strategies Record<string, string[]>
Project object
name string
package object
7 nested properties
name string
name_managed string
namespace string
install_class string
uninstall_class string
api_version string
metadata_package_id string
test object
1 nested properties
name_match string required
git object
10 nested properties
repo_url string
default_branch string
prefix_feature string
prefix_beta string
prefix_release string
push_prefix_sandbox string
push_prefix_production string
release_notes object
1 nested properties
parsers Record<string, object> required
2gp_context string
unlocked_context string
dependencies object[]
dependency_resolutions object
3 nested properties
production string
preproduction string
resolution_strategies Record<string, string[]>
dependency_pins object[]
source_format string
Default: "mdapi"
Values: "sfdx" "mdapi"
custom object
ScratchOrg object
config_file string
format=path
days integer
namespaced string
setup_flow string
noancestors boolean
release string
Values: "preview" "previous"
Orgs object
scratch Record<string, object>
ServiceAttribute object
description string
required boolean
default_factory string
default string
sensitive boolean
Default: false
Service object
description string
class_path string
attributes Record<string, object>
validator string
CumulusCIConfig object
keychain string required
Plan object
title string
description string
tier string
Default: "primary"
Values: "primary" "secondary" "additional"
slug string
is_listed boolean
Default: true
steps Record<string, object>
checks PreflightCheck[]
Default:
[]
error_message string
post_install_message string
preflight_message string
allowed_org_providers string[]
Default:
[
  "user"
]
LocalFolderSourceModel object
path string required
format=directory-path
allow_remote_code boolean
Default: false
GitHubSourceRelease string

An enumeration.

GitHubSourceModel object
github string required
resolution_strategy string
commit string
ref string
branch string
tag string
release string

An enumeration.

Values: "latest" "previous" "latest_beta"
description string
allow_remote_code boolean
Default: false
CumulusCLIConfig object
show_stacktraces boolean
Default: false
plain_output boolean