Add option for terraform fmt to write changes to source files (hashicorp#138)

* Add option to write formatting changes

* Add output whether formatting was written to source

* Update terraform_fmt.sh

* using variable for recursive

* Fix typo

Co-Authored-By: Matthew Sanabria <[email protected]>

* Improve logic check

Co-Authored-By: Matthew Sanabria <[email protected]>

* Use zero to represent false

Co-Authored-By: Matthew Sanabria <[email protected]>

* Use one to represent true

Co-Authored-By: Matthew Sanabria <[email protected]>

* Update logic check to use one

Co-Authored-By: Matthew Sanabria <[email protected]>

* Add missing spacing

Co-Authored-By: Matthew Sanabria <[email protected]>

Co-authored-by: Ryan Butler <[email protected]>
Co-authored-by: Matthew Sanabria <[email protected]>

Author: 3 people

README.md

@@ -75,6 +75,7 @@ Inputs configure Terraform GitHub Actions to perform different actions.
 * `tf_actions_cli_credentials_token` - (Optional) Token for the CLI credentials file.
 * `tf_actions_comment` - (Optional) Whether or not to comment on GitHub pull requests. Defaults to `true`.
 * `tf_actions_working_dir` - (Optional) The working directory to change into before executing Terraform subcommands. Defaults to `.` which means use the root of the GitHub repository.
+* `tf_actions_fmt_write` - (Optional) Whether or not to write `fmt` changes to source files. Defaults to `false`.
 
 ## Outputs
 
@@ -83,6 +84,7 @@ Outputs are used to pass information to subsequent GitHub Actions steps.
 * `tf_actions_output` - The Terraform outputs in (stringified) JSON format.
 * `tf_actions_plan_has_changes` - `'true'` if the Terraform plan contained changes, otherwise `'false'`.
 * `tf_actions_plan_output` - The Terraform plan output.
+* `tf_actions_fmt_written` - Whether or not the Terraform formatting from `fmt` was written to source files.
 
 ## Secrets
 

action.yml

@@ -22,13 +22,18 @@ inputs:
   tf_actions_working_dir:
     description: 'Terraform working directory.'
     default: '.'
+  tf_actions_fmt_write:
+    description: 'Write Terraform fmt changes to source files.'
+    default: false
 outputs:
   tf_actions_output:
     description: 'The Terraform outputs in JSON format.'
   tf_actions_plan_has_changes:
     description: 'Whether or not the Terraform plan contained changes.'
   tf_actions_plan_output:
     description: 'The Terraform plan output.'
+  tf_actions_fmt_written:
+    description: 'Whether or not the Terraform formatting was written to source files.'
 runs:
   using: 'docker'
   image: './Dockerfile'

src/main.sh

@@ -52,6 +52,11 @@ function parseInputs {
     tfCLICredentialsToken=${INPUT_TF_ACTIONS_CLI_CREDENTIALS_TOKEN}
   fi
 
+  tfFmtWrite=0
+  if [ "${INPUT_TF_ACTIONS_FMT_WRITE}" == "1" ] || [ "${INPUT_TF_ACTIONS_FMT_WRITE}" == "true" ]; then
+    tfFmtWrite=1
+  fi
+
   tfWorkspace="default"
   if [ -n "${TF_WORKSPACE}" ]; then
     tfWorkspace="${TF_WORKSPACE}"

src/terraform_fmt.sh

@@ -66,5 +66,14 @@ ${fmtComment}
     echo "${fmtPayload}" | curl -s -S -H "Authorization: token ${GITHUB_TOKEN}" --header "Content-Type: application/json" --data @- "${fmtCommentsURL}" > /dev/null
   fi
 
+  # Write changes to branch
+  echo "::set-output name=tf_actions_fmt_written::false"
+  if [ "${tfFmtWrite}" == "1" ]; then
+    echo "fmt: info: Terraform files in ${tfWorkingDir} will be formatted"
+    terraform fmt -write=true ${fmtRecursive} "${*}"
+    fmtExitCode=${?}
+    echo "::set-output name=tf_actions_fmt_written::true"
+  fi
+
   exit ${fmtExitCode}
 }