Add 'aws_site_error_document' config support (#18)

* add var 'aws_site_error_document' in variables.tf

* add error_document to bucket website config in main.tf

* add aws_site_error_document in generate_deploy.sh

* Add 'aws_site_error_document' in action.yaml

* Update action.yaml

* Revert "Update action.yaml"

This reverts commit afe02eb.

* Set the error document to an empty string by default in variables.tf

* Update variables.tf

---------

Co-authored-by: qixin <[email protected]>

Author: AaaCabbage

action.yaml

@@ -55,6 +55,9 @@ inputs:
   aws_site_root_object:
     description: 'Root object to be served as entry-point. Defaults to `index.html`'
     required: false
+  aws_site_error_document:
+    description: 'Error document set to S3 website config. Defaults to `error.html`'
+    required: false
   aws_site_bucket_name:
     description: ' AWS S3 bucket name to use for the public files. Defaults to `${org}-${repo}-{branch}-sp`'
     required: false
@@ -121,6 +124,7 @@ runs:
         # Site
         AWS_SITE_SOURCE_FOLDER: ${{ inputs.aws_site_source_folder }}
         AWS_SITE_ROOT_OBJECT: ${{ inputs.aws_site_root_object }}
+        AWS_SITE_ERROR_DOCUMENT: ${{ inputs.aws_site_error_document }}
         AWS_SITE_BUCKET_NAME: ${{ inputs.aws_site_bucket_name }}
         AWS_SITE_CDN_ENABLED: ${{ inputs.aws_site_cdn_enabled }}
         AWS_SITE_CDN_CUSTOM_ERROR_CODES: ${{ inputs.aws_site_cdn_custom_error_codes }}
@@ -220,4 +224,4 @@ runs:
       run: |
         echo "## Workflow failed to run :fire:" >> $GITHUB_STEP_SUMMARY
         echo "Please check the logs for possible errors." >> $GITHUB_STEP_SUMMARY
-        echo "If you consider this is a bug in the Github Action, please submit an issue to our repo." >> $GITHUB_STEP_SUMMARY
+        echo "If you consider this is a bug in the Github Action, please submit an issue to our repo." >> $GITHUB_STEP_SUMMARY

scripts/generate_deploy.sh

@@ -90,6 +90,7 @@ aws_site_bucket_name=$(generate_var aws_site_bucket_name $AWS_SITE_BUCKET_NAME)
 aws_site_cdn_enabled=$(generate_var aws_site_cdn_enabled $AWS_SITE_CDN_ENABLED)
 aws_site_cdn_custom_error_codes=$(generate_var aws_site_cdn_custom_error_codes $AWS_SITE_CDN_CUSTOM_ERROR_CODES)
 aws_site_root_object=$(generate_var aws_site_root_object $AWS_SITE_ROOT_OBJECT)
+aws_site_error_document=$(generate_var aws_site_error_document $AWS_SITE_ERROR_DOCUMENT)
 aws_r53_domain_name=$(generate_var aws_r53_domain_name $AWS_R53_DOMAIN_NAME)
 aws_r53_root_domain_deploy=$(generate_var aws_r53_root_domain_deploy $AWS_R53_ROOT_DOMAIN_DEPLOY)
 #aws_r53_enable_cert=$(generate_var aws_r53_enable_cert $AWS_R53_ENABLE_CERT)
@@ -110,6 +111,7 @@ $aws_site_bucket_name
 $aws_site_cdn_enabled
 $aws_site_cdn_custom_error_codes
 $aws_site_root_object
+$aws_site_error_document
 $aws_r53_domain_name
 $aws_r53_sub_domain_name
 $aws_r53_root_domain_deploy

terraform_code/main.tf

@@ -9,6 +9,10 @@ resource "aws_s3_bucket_website_configuration" "aws_site_website_bucket" {
   index_document {
     suffix = var.aws_site_root_object
   }
+
+  error_document {
+    key = var.aws_site_error_document
+  }
 }
 
 ## Only create this two IF -> R53 FQDN provided and CDN is off - for www.* support
@@ -469,4 +473,4 @@ output "cloudfront_url" {
 
 output "public_url" {
   value = local.public_url
-}
+}

terraform_code/variables.tf

@@ -31,6 +31,12 @@ variable "aws_site_root_object" {
   default     = "index.html"
 }
 
+variable "aws_site_error_document" {
+  description = "error document. Defaults to empty"
+  type        = string
+  default     = ""
+}
+
 variable "aws_site_bucket_name" {
   description = "Bucket name where all the files will be stored."
   type        = string
@@ -115,4 +121,4 @@ locals {
     GitHubAction              = "bitovi/github-actions-deploy-static-site-to-aws"
     created_with              = "terraform"
   }
-}
+}