Add option to set terraform state file name and append extras (#11)

* Add option to set terraform state file name and append extras

* Cosmetics in README

Author: LeoDiazL

README.md

@@ -56,7 +56,7 @@ jobs:
 
     steps:
     - name: Create deploy-bucket
-      uses: bitovi/[email protected].0
+      uses: bitovi/[email protected].1
       with:
         aws_access_key_id: ${{ secrets.AWS_ACCESS_KEY_ID }}
         aws_secret_access_key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
@@ -108,6 +108,8 @@ The following inputs can be used as `step.with` keys
 | Name             | Type    | Description                        |
 |------------------|---------|------------------------------------|
 | `tf_action` | String | Option to run Terraform `apply` / `destroy` action. Will run `plan` if nothing defined. |
+| `tf_state_file_name` | String | Change this to be anything you want to. Careful to be consistent here. A missing file could trigger recreation, or stepping over destruction of non-defined objects. Defaults to `tf-state-site`. |
+| `tf_state_file_name_append` | String | Appends a string to the tf-state-file. Setting this to `unique` will generate `tf-state-aws-unique`. (Can co-exist with `tf_state_file_name`) |
 | `tf_state_bucket` | String | AWS S3 bucket name to use for Terraform state. Defaults to `${org}-${repo}-{branch}-tf-state` |
 | `tf_state_bucket_destroy` | Boolean | Force purge and deletion of S3 bucket defined if terraform destroy action succeded. |
 <hr/>

action.yaml

@@ -35,6 +35,12 @@ inputs:
   tf_action: 
     desctiption: 'Option to run Terraform apply / destroy option. Will run plan if nothing defined.'
     required: false
+  tf_state_file_name:
+    description: 'Change this to be anything you want to. Carefull to be consistent here. A missing file could trigger recreation, or stepping over destruction of non-defined objects.'
+    required: false
+  tf_state_file_name_append:
+    description: 'Append a string to the tf-state-file. Setting this to `unique` will generate `tf-state-aws-unique`. Can co-exist with the tf_state_file_name variable. '
+    required: false
   tf_state_bucket:
     description: 'AWS S3 bucket to use for Terraform state. Defaults to `${org}-${repo}-{branch}-tf-state`'
     required: false
@@ -105,6 +111,8 @@ runs:
         AWS_RESOURCE_IDENTIFIER: ${{ inputs.aws_resource_identifier }}
         AWS_ADDITIONAL_TAGS: ${{ inputs.aws_additional_tags }}
         # TF
+        TF_STATE_FILE_NAME: ${{ inputs.tf_state_file_name }}
+        TF_STATE_FILE_NAME_APPEND: ${{ inputs.tf_state_file_name_append }}
         TF_STATE_BUCKET: ${{ inputs.tf_state_bucket }}
         TF_STATE_BUCKET_DESTROY: ${{ inputs.tf_state_bucket_destroy }}
         # Site

scripts/generate_provider.sh

@@ -10,6 +10,19 @@ set -e
 
 echo "In generate_provider.sh"
 
+function generate_tf_state_file_name () {
+  if [ -n "$TF_STATE_FILE_NAME" ]; then
+    filename="$TF_STATE_FILE_NAME"
+  else
+    filename="tf-state-$1"
+  fi
+
+  if [ -n "$TF_STATE_FILE_NAME_APPEND" ]; then
+    filename="${filename}-${TF_STATE_FILE_NAME_APPEND}"
+  fi
+  echo $filename
+}
+
 echo "
 terraform {
   required_providers {
@@ -26,7 +39,7 @@ terraform {
   backend \"s3\" {
     region  = \"${AWS_DEFAULT_REGION}\"
     bucket  = \"${TF_STATE_BUCKET}\"
-    key     = \"tf-state-site\"
+    key     = \"$(generate_tf_state_file_name site)\"
     encrypt = true #AES-256encryption
   }
 }