Added terraform output to summary

.github/workflows/integration-tests.yml

@@ -9,6 +9,7 @@ on:
 env:
   AWS_REGION: us-east-2
 
+
 # Permissions required for assuming AWS identity
 permissions:
   id-token: write
@@ -35,11 +36,12 @@ jobs:
           EOL
 
       - name: Plan Atmos Component
-        uses: cloudposse/github-action-atmos-terraform-plan@incapsulate-configs
+        uses: cloudposse/github-action-atmos-terraform-plan@v1
         with:
           component: "foobar"
           stack: "plat-ue2-sandbox"
           atmos-gitops-config-path: "${{ runner.temp }}/atmos-gitops.yaml"
+
   test:
     runs-on: ubuntu-latest
     needs: setup

README.md

@@ -301,6 +301,57 @@ specific language governing permissions and limitations
 under the License.
 ```
 
+
+## Apply Succeeded for `foobar` in `plat-ue2-sandbox`
+
+
+
+<a href="https://cloudposse.com/"><img src="https://cloudposse.com/logo-300x69.svg" width="100px" align="right"/></a>
+
+
+[![apply](https://shields.io/badge/APPLY-SUCCESS-success?style=for-the-badge)](#user-content-apply-plat-ue2-sandbox-foobar)
+
+
+<details><summary><a id="result-plat-ue2-sandbox-foobar" />Apply complete! Resources: 1 added, 0 changed, 1 destroyed.</summary>
+
+<br/>
+To reproduce this locally, run:<br/><br/>
+
+```shell
+atmos terraform apply foobar -s plat-ue2-sandbox
+```
+</details>
+
+
+<details><summary><a id="apply-plat-ue2-sandbox-foobar" />Terraform <strong>Apply</strong> Summary</summary>
+
+```hcl
+random_id.foo: Destroying... [id=oIE_s3bSF9A]
+random_id.foo: Destruction complete after 0s
+random_id.foo: Creating...
+random_id.foo: Creation complete after 0s [id=WGAQulCR148]
+
+Apply complete! Resources: 1 added, 0 changed, 1 destroyed.
+
+Outputs:
+
+result = "WGAQulCR148"
+sensitive_value = <sensitive>
+
+```
+
+</details>
+
+<details><summary><a id="outputs-plat-ue2-sandbox-foobar" />Terraform Outputs</summary>
+
+| name | value         |
+|----|---------------|
+| result | "WGAQulCR148" |
+| sensitive_value | \<sensitive\> |
+
+</details>
+
+
 ## Trademarks
 
 All other trademarks referenced herein are the property of their respective owners.

action.yml

@@ -141,6 +141,13 @@ runs:
         repo: suzuki-shunsuke/tfcmt
         tag: v4.6.0
 
+    - name: Install terraform-docs
+      if: env.ACTIONS_ENABLED == 'true'
+      uses: jaxxstorm/[email protected]
+      with:
+        repo: terraform-docs/terraform-docs
+        tag: v0.17.0
+
     - name: Define Job Variables
       if: env.ACTIONS_ENABLED == 'true'
       id: vars
@@ -289,6 +296,17 @@ runs:
           --output "${{ github.workspace }}/atmos-apply-summary.md" \
           --log-level $([[ "${{ inputs.debug }}" == "true" ]] && echo "DEBUG" || echo "INFO") \
           apply -- terraform apply ${{ steps.vars.outputs.plan_file }} || EXIT_CODE=$?
+
+        terraform output --json > output_values.json
+
+        echo "terraform-docs -c ${{ github.action_path }}config/tfdocs-config.yaml ./"
+
+        terraform-docs -c ${{ github.action_path }}config/tfdocs-config.yaml --output-file ${{ github.workspace }}/atmos-apply-summary.md ./
+
+        sed -i "s#\`<sensitive>\`#![Sensitive](https://img.shields.io/badge/sensitive-c40000?style=for-the-badge)#g" ${{ github.workspace }}/atmos-apply-summary.md
+        sed -i "s#\`\"#\`#g" ${{ github.workspace }}/atmos-apply-summary.md
+        sed -i "s#\"\`#\`#g" ${{ github.workspace }}/atmos-apply-summary.md
+        sed -i "s#|--#|:-#g" ${{ github.workspace }}/atmos-apply-summary.md
 
         cat "${{ github.workspace }}/atmos-apply-summary.md" >> $GITHUB_STEP_SUMMARY
 

config/atmos_github_summary.yaml

@@ -69,6 +69,15 @@ terraform:
       <details><summary><a id="apply-{{.Vars.stack}}-{{.Vars.component}}" />Terraform <strong>Apply</strong> Summary</summary>
       {{wrapCode .CombinedOutput}}
       </details>
+
+      <details><summary><a id="outputs-{{.Vars.stack}}-{{.Vars.component}}" />Terraform Outputs</summary>
+
+      [//]: # (BEGIN_TF_DOCS)
+
+      [//]: # (END_TF_DOCS)
+
+      </details>
+
       {{if ne .Vars.infracost_details_diff_breakdown ""}}
       {{template "infracost" .}}
       {{end}}

config/tfdocs-config.yaml

@@ -0,0 +1,40 @@
+formatter: "markdown"
+
+sections:
+  show:
+    - outputs
+
+content: |-
+  {{ .Outputs }}
+
+output:
+  file: "atmos-apply-summary.md"
+  mode: inject
+  template: |-
+    [//]: # (BEGIN_TF_DOCS)
+    {{ .Content }}
+
+    [//]: # (END_TF_DOCS)
+
+output-values:
+  enabled: true
+  from: "output_values.json"
+
+sort:
+  enabled: true
+  by: name
+
+settings:
+  anchor: false
+  color: true
+  default: true
+  description: false
+  escape: true
+  hide-empty: false
+  html: true
+  indent: 2
+  lockfile: true
+  read-comments: true
+  required: true
+  sensitive: false
+  type: true

tests/components/terraform/foobar/outputs.tf

@@ -0,0 +1,21 @@
+output "result" {
+  description = "Test description output"
+  value       = random_id.foo.id
+}
+
+output "sensitive_value" {
+  description = "Test sensitive description output"
+  value       = random_id.foo.id
+  sensitive   = true
+}
+
+
+output "structured_value" {
+  description = "Test structured output"
+  value       = {
+    test = "test"
+    value = {
+      result = random_id.foo.id
+    }
+  }
+}