Configuration keys

  • access_control: Reference for the access_control key in .stategraph/config.yml. Define who can plan, apply, unlock, and override apply requirements.
  • Apply Requirements and Overrides: Reference for the apply_requirements key in .stategraph/config.yml. Configure approvals, merge conflict and status checks, and overrides.
  • automerge: Reference for the automerge key in .stategraph/config.yml. Merge the pull request automatically after every directory applies successfully.
  • batch_runs: Reference for the batch_runs key in .stategraph/config.yml. Limit how many workspaces a single CI run executes in large repositories.
  • config_builder: Reference for the config_builder key in .stategraph/config.yml. Generate the repository configuration at runtime with a custom script.
  • cost_estimation: Reference for the cost_estimation key in .stategraph/config.yml. Post Infracost monthly cost changes alongside every plan comment.
  • default_branch_overrides: Reference for the default_branch_overrides key in .stategraph/config.yml. Choose which root keys are read from the default branch.
  • definitions: Reference for the definitions key in .stategraph/config.yml. Hold YAML anchors that other sections reuse, with the merge rules that apply.
  • destination_branches: Reference for the destination_branches key in .stategraph/config.yml. Control which target and source branches trigger operations.
  • dirs: Reference for the dirs key in .stategraph/config.yml. Assign tags, workspaces, and when_modified rules to directories, with glob matching.
  • drift: Reference for the drift key in .stategraph/config.yml. Schedule drift detection and reconciliation, set run windows, and create issues.
  • enabled: Reference for the top-level enabled key in .stategraph/config.yml. Turn Stategraph Orchestration on or off for a whole repository.
  • engine: Reference for the engine key in .stategraph/config.yml. Choose Terraform, OpenTofu, Terragrunt, CDKTF, Pulumi, Stategraph, or a custom engine.
  • hooks: Reference for the hooks key in .stategraph/config.yml. Run commands, set environment variables, and open OIDC sessions before and after runs.
  • Ignoring a Directory: Configure .stategraph/config.yml so that changes in specific directories or files never trigger automatic plans and applies.
  • indexer: Reference for the indexer key in .stategraph/config.yml. Generate directory and module configuration by analyzing your Terraform code.
  • lock_policy: Reference for the lock_policy key in .stategraph/config.yml. Decide when a directory and workspace acquire a lock across the repository.
  • notifications: Reference for the notifications key in .stategraph/config.yml. Control comment strategies, the run summary, and per-dirspace status checks.
  • parallel_runs: Reference for the parallel_runs key in .stategraph/config.yml. Set how many Terraform runs execute concurrently across directories.
  • stacks: Reference for the stacks key in .stategraph/config.yml. Group dirspaces into named stacks with shared variables and ordering rules.
  • storage: Reference for the storage key in .stategraph/config.yml. Keep plan files in the server database, an S3 bucket, custom commands, or nowhere.
  • Tag Queries: Reference for tag queries in .stategraph/config.yml. Define tags, combine them with and, or, not, and in, and target workflows and commands.
  • tags: Reference for the top-level tags key in .stategraph/config.yml. Derive dest_branch and branch tags from branch names with Lua patterns.
  • tree_builder: Reference for the tree_builder key in .stategraph/config.yml. Replace Git change detection with a script that lists files and their content IDs.
  • version: Reference for the version key in .stategraph/config.yml. The configuration file format version, which must be the quoted string "1".
  • when_modified: The when_modified key in .stategraph/config.yml sets file patterns, autoplan, autoapply, prechecks, and the depends_on order of directories.
  • workflows: The workflows key in .stategraph/config.yml sets the plan and apply steps, engine, environment, OIDC, gates, and scanners per directory.