Small tweaks and cosmetics (#19)

* Small tweaks and cosmetics

* Typo

* Fixing examples

Author: LeoDiazL

README.md

@@ -56,7 +56,7 @@ jobs:
 
     steps:
     - name: Create deploy-bucket
-      uses: bitovi/[email protected].2
+      uses: bitovi/[email protected].3
       with:
         aws_access_key_id: ${{ secrets.AWS_ACCESS_KEY_ID }}
         aws_secret_access_key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
@@ -66,6 +66,7 @@ jobs:
         tf_state_bucket_destroy: true # If destroying, will remove the bucket
 
         aws_site_cdn_enabled: true
+        #aws_site_error_document: error.html # Optional error file
 
         aws_r53_domain_name: example.com # You should own and have this domain available in R53
         aws_r53_sub_domain_name: site
@@ -84,7 +85,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Create deploy-bucket
-        uses: bitovi/[email protected].2
+        uses: bitovi/[email protected].3
         with:
           aws_access_key_id: ${{ secrets.AWS_ACCESS_KEY_ID }}
           aws_secret_access_key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
@@ -110,7 +111,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Create deploy-bucket
-        uses: bitovi/[email protected].2
+        uses: bitovi/[email protected].3
         with:
           aws_access_key_id: ${{ secrets.AWS_ACCESS_KEY_ID }}
           aws_secret_access_key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
@@ -181,7 +182,8 @@ The following inputs can be used as `step.with` keys
 | Name             | Type    | Description                        |
 |------------------|---------|------------------------------------|
 | `aws_site_source_folder` | String | Source folder for files to be published. Will ignore any hidden file. Defaults to root folder of the calling repo if nothing defined. |
-| `aws_site_root_object` | Boolean | Root object to be served as entry-point. Defaults to `index.html`. |
+| `aws_site_root_object` | String | Root object to be served as entry-point. Defaults to `index.html`. |
+| `aws_site_error_document` | String | Error document set to S3 website config. Defaults to none. Set value to enable it. |
 | `aws_site_bucket_name` | String | AWS S3 bucket name to use for the public files. Defaults to `${org}-${repo}-{branch}-sp`. If using a R53 domain and not a CDN, bucket name will be the FQDN one. See note. |
 | `aws_site_cdn_enabled` | Boolean | Enable or disables the use of CDN. Defaults to `false`. |
 | `aws_site_cdn_custom_error_codes` | JSON | Custom error codes to define in CDN. Like `[{\"error_caching_min_ttl\":\"0\",\"error_code\":\"403\",\"response_code\":\"200\",\"response_page_path\":\"/index.html\"}]`. See [this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudfront_distribution.html#custom-error-response-arguments). |

action.yaml

@@ -56,7 +56,7 @@ inputs:
     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`'
+    description: 'Error document set to S3 website config. Defaults to none.'
     required: false
   aws_site_bucket_name:
     description: ' AWS S3 bucket name to use for the public files. Defaults to `${org}-${repo}-{branch}-sp`'

terraform_code/main.tf

@@ -10,8 +10,11 @@ resource "aws_s3_bucket_website_configuration" "aws_site_website_bucket" {
     suffix = var.aws_site_root_object
   }
 
-  error_document {
-    key = var.aws_site_error_document
+  dynamic "error_document" {
+    for_each = var.aws_site_error_document != "" ? [1] : []
+    content {
+      key = var.aws_site_error_document
+    }
   }
 }
 

terraform_code/variables.tf

@@ -32,7 +32,7 @@ variable "aws_site_root_object" {
 }
 
 variable "aws_site_error_document" {
-  description = "error document. Defaults to empty"
+  description = "Error document. Defaults to none"
   type        = string
   default     = ""
 }