terraform-provider-stackgen

sg_evidence_checklist (Resource)

⚠️ Experimental — This resource is part of the Guild platform and may change in future releases.

Manages an evidence checklist — required and optional evidence items, scoring rules, and metadata used as proof of work for investigations and remediation.

Attach a checklist to a whole workflow using sg_workflow.evidence_checklist_ref (workflow-scoped, not per-stage).

Create-time 409 adoption is controlled by the provider attribute adopt_on_conflict (default true).

Example Usage

resource "sg_evidence_checklist" "example" {
  name        = "post-incident-review"
  description = "Artifacts required before closing a Sev-1 incident."

  required_items = [
    "timeline_reconstructed",
    "blast_radius_documented",
  ]
  optional_items = ["customer_comms_log"]

  scoring {
    min_required         = 2
    confidence_threshold = 0.8
  }

  metadata = {
    team = "sre"
  }

  # Set true to call POST .../versions/{v}/approve after create/update (same pattern as sg_workflow.approve).
  approve = false
}

# Use this checklist as workflow-wide proof-of-work (entire playbook, all stages):
# resource "sg_workflow" "with_evidence" {
#   ...
#   evidence_checklist_ref = sg_evidence_checklist.example.name
# }

Import

Import an existing sg_evidence_checklist using its name:

terraform import sg_evidence_checklist.example 'verify-deployment'

Schema

Required

• name (String) Unique evidence checklist name. Changing forces replacement.

Optional

• approve (Boolean) When true, promotes the checklist version after create or update via the Guild approve API so operators do not need the UI. Omit or set false to leave draft versions pending.
• description (String) Human-readable description of what this checklist enforces.
• metadata (Map of String) String-valued metadata keys for classification (passed through to Guild).
• optional_items (List of String) Evidence items that are nice to have.
• required_items (List of String) Evidence items that must be collected (proof-of-work expectations).
• scoring (Attributes) Pass or fail criteria for evidence completeness. (see below for nested schema)

Read-Only

• id (String) Server-assigned identifier.
• status (String) Version lifecycle state (draft, approved, deprecated).
• version (Number) Integer version of the checklist body. Managed by the server: starts at 1 on create and auto-increments when a new draft is created during an update.

Nested Schema for scoring

Optional:

• confidence_threshold (Number) Minimum confidence score between 0.0 and 1.0.
• min_required (Number) Minimum number of required checklist items that must be satisfied to pass.