.tfcmt.yaml

# Configuration file for tfcmt tool used to run terraform commands and post results to github.

# plan_patch option enables patching existing tfcmt comments instead of creating new ones.
# This is useful when you want to keep the comment history clean. This option is valid for the tfcmt plan command only.
# Setting it in configuration file instead of a command line argument will make it default for all plan commands without
# need to define separate arguments list for the apply command. This makes the tekton terraform-executor task definition simpler and more readable.
plan_patch: true
embedded_var_names: []
ci:
  pr: []
  owner: []
  repo: []
  sha: []
  link: []
  vars: {}
templates:
  plan_title: "## {{if eq .ExitCode 1}}:x: {{end}}Plan Result{{if .Vars.target}} ({{.Vars.target}}){{end}}"
  apply_title: "## :{{if eq .ExitCode 0}}white_check_mark{{else}}x{{end}}: Apply Result{{if .Vars.target}} ({{.Vars.target}}){{end}}"
  
  result: "{{if .Result}}<pre><code>{{ .Result }}</code></pre>{{end}}"
  updated_resources: |
    {{if .CreatedResources}}
    * Create
    {{- range .CreatedResources}}
      * {{avoidHTMLEscape .}}
    {{- end}}{{end}}{{if .UpdatedResources}}
    * Update
    {{- range .UpdatedResources}}
      * {{avoidHTMLEscape .}}
    {{- end}}{{end}}{{if .DeletedResources}}
    * Delete
    {{- range .DeletedResources}}
      * {{avoidHTMLEscape .}}
    {{- end}}{{end}}{{if .ReplacedResources}}
    * Replace
    {{- range .ReplacedResources}}
      * {{avoidHTMLEscape .}}
    {{- end}}{{end}}
  deletion_warning: |
    {{if .HasDestroy}}
    ### :warning: Resource Deletion will happen :warning:
    This plan contains resource delete operation. Please check the plan result very carefully!
    {{end}}
  changed_result: |
    {{if .ChangedResult}}
    <details><summary>Change Result (Click me)</summary>
    {{wrapCode .ChangedResult}}
    </details>
    {{end}}
  change_outside_terraform: |
    {{if .ChangeOutsideTerraform}}
    <details><summary>:information_source: Objects have changed outside of Terraform</summary>
    
    _This feature was introduced from [Terraform v0.15.4](https://github.com/hashicorp/terraform/releases/tag/v0.15.4)._
    {{wrapCode .ChangeOutsideTerraform}}
    </details>
    {{end}}
  warning: |
    {{if .Warning}}
    ## :warning: Warnings :warning:
    {{wrapCode .Warning}}
    {{end}}
  error_messages: |
    {{if .ErrorMessages}}
    ## :warning: Errors
    {{range .ErrorMessages}}
    * {{. -}}
    {{- end}}{{end}}
  guide_apply_failure: ""
  guide_apply_parse_error: ""
terraform:
  plan:
    disable_label: false
    template: |
      {{template "plan_title" .}}
      
      {{if .Link}}[CI link]({{.Link}}){{end}}
      
      {{template "deletion_warning" .}}
      {{template "result" .}}
      {{template "updated_resources" .}}
      
      {{template "changed_result" .}}
      {{template "change_outside_terraform" .}}
      {{template "warning" .}}
      {{template "error_messages" .}}
    when_add_or_update_only:
      label: "{{if .Vars.target}}{{.Vars.target}}/{{end}}add-or-update"
      label_color: 1d76db # blue
      # disable_label: false
    when_destroy:
      label: "{{if .Vars.target}}{{.Vars.target}}/{{end}}destroy"
      label_color: d93f0b # red
      # disable_label: false
    when_no_changes:
      label: "{{if .Vars.target}}{{.Vars.target}}/{{end}}no-changes"
      label_color: 0e8a16 # green
      # disable_label: false
      # disable_comment: false
    when_plan_error:
      label:
      label_color:
      # disable_label: false
    when_parse_error:
      template: |
        {{template "plan_title" .}}
        
        {{if .Link}}[CI link]({{.Link}}){{end}}
        
        It failed to parse the result.
        
        <details><summary>Details (Click me)</summary>
        {{wrapCode .CombinedOutput}}
        </details>
  apply:
    template: |
      {{template "apply_title" .}}
      
      {{if .Link}}[CI link]({{.Link}}){{end}}
      
      {{if ne .ExitCode 0}}{{template "guide_apply_failure" .}}{{end}}
      
      {{template "result" .}}
      
      <details><summary>Details (Click me)</summary>
      {{wrapCode .CombinedOutput}}
      </details>
      {{template "error_messages" .}}`
    when_parse_error:
      template: |
        {{template "apply_title" .}}
        
        {{if .Link}}[CI link]({{.Link}}){{end}}
        
        {{template "guide_apply_parse_error" .}}
        
        It failed to parse the result.
        
        <details><summary>Details (Click me)</summary>
        {{wrapCode .CombinedOutput}}
        </details>