Skip to content

Commit

Permalink
πŸ› FIX: Terraform docs CI (#7)
Browse files Browse the repository at this point in the history
* πŸ› FIX: Terraform docs CI

* terraform-docs: automated update action

Co-authored-by: caiovfernandes <[email protected]>
  • Loading branch information
caiovfernandes and caiovfernandes committed Oct 27, 2021
1 parent 7da4fc6 commit 8ba25e4
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 9 deletions.
8 changes: 2 additions & 6 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -1,17 +1,13 @@
name: Generate terraform docs

on:
push:
branches:
- master

on: [pull_request]
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
ref: master
ref: ${{ github.head_ref }}

- name: Render terraform docs inside the README.md and push changes back to pushed branch
uses: DNXLabs/[email protected]
Expand Down
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@ The following resources will be created:

## Requirements

No requirements.
| Name | Version |
|------|---------|
| terraform | >= 0.13.0 |

## Providers

Expand All @@ -31,8 +33,8 @@ No requirements.
| alarm\_email | Enables email notification (optional) | `string` | `""` | no |
| alarm\_slack\_endpoint | Enables slack notification to endpoint passed (optional) | `string` | `""` | no |
| invite | Invite member accounts? (Use 'false' when this account is the delegated admin by master account) | `bool` | `true` | no |
| members | List of member AWS accounts as [{account\_id: '9999', email: '[email protected]'}, {...}] } | `list` | `[]` | no |
| severity\_list | n/a | `list` | <pre>[<br> "HIGH",<br> "CRITICAL"<br>]</pre> | no |
| members | List of member AWS accounts as [{account\_id: '9999', email: '[email protected]'}, {...}] } | `list(any)` | `[]` | no |
| severity\_list | n/a | `list(any)` | <pre>[<br> "HIGH",<br> "CRITICAL"<br>]</pre> | no |
| subscription\_cis | Enables CIS Foundations Benchmark Standards subscription | `bool` | `false` | no |
| subscription\_foundational | Enables AWS Foundational Security Best Practices subscription | `bool` | `false` | no |
| subscription\_pci | Enables PCI-DSS Standards subscription | `bool` | `false` | no |
Expand Down

0 comments on commit 8ba25e4

Please sign in to comment.