Tweaks (#3)

* Update action.yaml
* Escaping echo chars
* Removing show details - prettify action
* Removing unnecessary file
* Adding support for bucket with DNS and no CDN
* Fixing and enforcing dependencies
* Updating README.md

Author: LeoDiazL

README.md

@@ -4,6 +4,16 @@ GitHub action to deploy anything into a bucket, adding the options to add a CDN
 
 This action will copy the files from the defined folder into an S3 bucket, defining the content type and serving ALL OF THEM PUBLICLY. 
 
+## Action main options graph
+
+```mermaid
+graph TD;
+    A[S3 Bucket] --> B[S3 Endpoint]
+    A -->|DNS| C[Direct S3 DNS] --> G[- No SSL\n- 63 chars FQDN limit]
+    A -->|CDN| D[CDN Public URL] --> H[- SSL\n- CND URL]
+    A -->|CDN + DNS| E[Public FQDN] --> I[- Owned SSL cert\n- Unlimited FQDN length]
+```
+
 ## Requirements 
 
 1. Files to publish
@@ -27,7 +37,6 @@ Setting `aws_r53_create_sub_cert` to `true` will create a certificate **just for
 
 > :warning: Be very careful here! **Created certificates are fully managed by Terraform**. Therefor **they will be destroyed upon stack destruction**.
 
-
 ## Example usage
 
 Create `.github/workflow/deploy.yaml` with the following to build on push.
@@ -97,7 +106,6 @@ 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_plan_show_details` | Boolean | Set to true to show a detailed output from Terraform plan. |
 | `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/>
@@ -108,7 +116,7 @@ The following inputs can be used as `step.with` keys
 |------------------|---------|------------------------------------|
 | `aws_spa_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_spa_root_object` | Boolean | Root object to be served as entry-point. Defaults to `index.html`. |
-| `aws_spa_website_bucket_name` | String | AWS S3 bucket name to use for the public files. Defaults to `${org}-${repo}-{branch}-sp` |
+| `aws_spa_website_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_spa_cdn_enabled` | Boolean | Enable or disables the use of CDN. Defaults to `false`. |
 <hr/>
 <br/>
@@ -135,6 +143,17 @@ We use the kubernetes style for this. For example, kubernetes -> k(# of characte
 
 For some specific resources, we have a 32 characters limit. If the identifier length exceeds this number after compression, we remove the middle part and replace it for a hash made up from the string itself. 
 
+## Note about bucket names
+
+As a default, the bucket name will be `${GITHUB_ORG_NAME}-${GITHUB_REPO_NAME}-${GITHUB_BRANCH_NAME}-sp`. 
+
+But, in the case you add a Route53 domain and no CDN, the bucket name must match the FQDN defined, like `spa.example.com`. If setting `aws_r53_root_domain_deploy`, two buckets will be created. `www.{aws_r53_domain_name}`and `{aws_r53_domain_name}`. Traffic from www bucket will be forwarded to the main bucket.
+Because of this reason, the length of the FQDN *MUST* be below 64 characters. Will try using the provided FQDN, if not, fallback to `resource-identifier.{aws_r53_domain_name}` of the compressed one. IF it still exceeds the limit, will remove as many as needed.
+
+> :warning: HTTPS (TLS / SSL) will only be available if using CDN.
+
+In the case you are using domains and not using a CDN, no cert will be available, and length of the FQDN *MUST* be below 64 characters. Will be adjusted if it exceeds that limit. 
+
 ## Contributing
 We would love for you to contribute to [bitovi/github-actions-deploy-static-site-to-aws](https://github.com/bitovi/github-actions-deploy-static-site-to-aws).
 Would you like to see additional features?  [Create an issue](https://github.com/bitovi/github-actions-deploy-static-site-to-aws/issues/new) or a [Pull Requests](https://github.com/bitovi/github-actions-deploy-static-site-to-aws/pulls). We love discussing solutions!

action.yaml

@@ -35,9 +35,6 @@ inputs:
   tf_action: 
     desctiption: 'Option to run Terraform apply / destroy option. Will run plan if nothing defined.'
     required: false
-  tf_plan_show_details:
-    description: 'Set to true to show a detailed output from Terraform plan.'
-    required: false
   tf_state_bucket:
     description: 'AWS S3 bucket to use for Terraform state. Defaults to `${org}-${repo}-{branch}-tf-state`'
     required: false
@@ -78,7 +75,6 @@ inputs:
     description: 'Generates and manage the sub-domain certificate for the application. Default is `false`.'
     required: false
 
-
 outputs:
   public_url:
     description: "The URL of the generated app"
@@ -124,54 +120,92 @@ runs:
         AWS_R53_CREATE_ROOT_CERT: ${{ inputs.aws_r53_create_root_cert }}
         AWS_R53_CREATE_SUB_CERT: ${{ inputs.aws_r53_create_sub_cert }}
       run: |
+        echo "::group::Generating Terraform pre-requisites" > /dev/null
         echo "running scripts/generate_deploy.sh"
         $GITHUB_ACTION_PATH/scripts/generate_deploy.sh
+        echo "::endgroup::"
 
     - name: Setup Terraform
       uses: hashicorp/setup-terraform@v2
 
     - name: Terraform Init
       id: init
       shell: bash
-      run: terraform -chdir=$GITHUB_ACTION_PATH/terraform_code init
+      run: |
+        echo "::group::Terraform Init"
+        terraform -chdir=$GITHUB_ACTION_PATH/terraform_code init
+        echo "::endgroup::"
     
     - name: Terraform Validate
       id: validate
       shell: bash
-      run: terraform -chdir=$GITHUB_ACTION_PATH/terraform_code validate
+      run:  |
+        echo "::group::Terraform Validate"
+        terraform -chdir=$GITHUB_ACTION_PATH/terraform_code validate
+        echo "::endgroup::"
     
     - name: Terraform Plan
-      if: ${{ success () && inputs.tf_show_plan_details == 'true' && inputs.tf_action != 'destroy' }}
+      if: ${{ success () && inputs.tf_action != 'destroy' }}
       id: plan
       shell: bash
-      run: terraform -chdir=$GITHUB_ACTION_PATH/terraform_code plan
-
-    - name: Terraform Show Plan Details
-      if: ${{ success () && inputs.tf_show_plan_details == 'true' && inputs.tf_action != 'destroy' }}
-      shell: bash
-      run: |
-        echo ${{ steps.plan.outputs.stdout }}
-        echo ${{ steps.plan.outputs.stderr }}
-        echo ${{ steps.plan.outputs.exitcode }}
+      run:  |
+        echo "::group::Terraform Plan"
+        terraform -chdir=$GITHUB_ACTION_PATH/terraform_code plan -input=false
+        echo "::endgroup::"
 
     - name: Terraform Apply
       id: apply
       if: ${{ success() && inputs.tf_action == 'apply' }}
       shell: bash
       run: |
+        echo "::group::Terraform Apply"
         terraform -chdir=$GITHUB_ACTION_PATH/terraform_code apply -auto-approve
+        echo "::endgroup::"
+        terraform -chdir=$GITHUB_ACTION_PATH/terraform_code output | grep public_url | sed -e 's/ *= */=/g' -e 's/"//g' >> $GITHUB_OUTPUT
 
     - name: Terraform Destroy
       if: ${{ success() && inputs.tf_action == 'destroy' }}
       shell: bash
-      run: |
+      run:  |
+        echo "::group::Terraform Destroy"
         terraform -chdir=$GITHUB_ACTION_PATH/terraform_code destroy -auto-approve
+        echo "::endgroup::"
 
-    - name: Terraform Destroy
+    - name: Purge and delete tf-state bucket
       if: ${{ success() && inputs.tf_action == 'destroy' && inputs.tf_state_bucket_destroy == 'true' }}
       shell: bash
       env: 
         TF_STATE_BUCKET: ${{ inputs.tf_state_bucket }}
+      run:  |
+        echo "::group::Purge and delete tf-state bucket"
+        $GITHUB_ACTION_PATH/scripts/destroy_tf_state_bucket.sh
+        echo "::endgroup::"
+
+    - name: Print result
+      if: ${{ success() && steps.apply.outputs.public_url != '' }}
+      shell: bash
+      run: |
+        echo "## It's published! :rocket:" >> $GITHUB_STEP_SUMMARY
+        echo ${{ steps.apply.outputs.public_url }} >> $GITHUB_STEP_SUMMARY
+
+    - name: Print result
+      if: ${{ success() inputs.tf_action == 'destroy' && inputs.tf_state_bucket_destroy == 'true' }}
+      shell: bash
+      run: |
+        echo "## Deploy Destroyed! :boom:" >> $GITHUB_STEP_SUMMARY
+        echo "Infrastructure should be gone now!" >> $GITHUB_STEP_SUMMARY
+
+     - name: Print result
+      if: ${{ success() inputs.tf_action == 'destroy' && inputs.tf_state_bucket_destroy != 'true' }}
+      shell: bash
+      run: |
+        echo "## Deploy Destroyed! :boom:" >> $GITHUB_STEP_SUMMARY
+        echo "Buckets and infrastructure should be gone now!" >> $GITHUB_STEP_SUMMARY
+ 
+    - name: Print error result
+      if: ${{ failure() }} 
+      shell: bash
       run: |
-        echo "running scripts/destroy_tf_state_bucket.sh"
-        $GITHUB_ACTION_PATH/scripts/destroy_tf_state_bucket.sh
+        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

scripts/copy_incoming_files.sh

@@ -33,6 +33,7 @@ echo "GITHUB_IDENTIFIER: [$GITHUB_IDENTIFIER]"
 GITHUB_IDENTIFIER_SS="$($GITHUB_ACTION_PATH/scripts/generate_identifier.sh 30)"
 echo "GITHUB_IDENTIFIER SS: [$GITHUB_IDENTIFIER_SS]"
 
+# Moving files, excluding hidden ones.
 SOURCE_FILES="$GITHUB_WORKSPACE/$AWS_SPA_SOURCE_FOLDER"
 rsync -av --exclude=".*" $SOURCE_FILES/ "${GITHUB_ACTION_PATH}/upload"
 SOURCE_FILES="${GITHUB_ACTION_PATH}/upload"