tfcmt.yml

# 以下のドキュメントにtfcmtの書き方が載っています。
# ref. https://suzuki-shunsuke.github.io/tfcmt/config 
# `< Organization Name >` 部分は適切な Organization Name に置き換えてください。
# `terraform-operations` は作成したリポジトリ名に変更してください。
ci:
  owner:
  - type: envsubst
    value: < Organization Name >
  repo:
  - type: envsubst
    value: terraform-operations
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}}
      * {{.}}
    {{- end}}{{end}}{{if .UpdatedResources}}
    * Update
    {{- range .UpdatedResources}}
      * {{.}}
    {{- end}}{{end}}{{if .DeletedResources}}
    * Delete
    {{- range .DeletedResources}}
      * {{.}}
    {{- end}}{{end}}{{if .ReplacedResources}}
    * Replace
    {{- range .ReplacedResources}}
      * {{.}}
    {{- 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: "@{{.Vars.pr_creator}} Please check the error."
  guide_apply_parse_error: "@{{.Vars.pr_creator}} Please check the error."
terraform:
  plan:
    disable_label: true
    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" .}}
  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" .}}