Skip to content

Commit f8ed011

Browse files
authored
Generate readme for submodules (#56)
1 parent 9c82f2f commit f8ed011

File tree

2 files changed

+147
-0
lines changed

2 files changed

+147
-0
lines changed

atmos.yaml

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,65 @@
99
# Import shared configuration used by all modules
1010
import:
1111
- https://raw.githubusercontent.com/cloudposse-terraform-components/.github/refs/heads/main/.github/atmos/terraform-component.yaml
12+
13+
docs:
14+
generate:
15+
readme-submodule:
16+
base-dir: ./
17+
input:
18+
- readme: "./src/modules/redis_cluster/README.md"
19+
- get_support: true
20+
template: "https://raw.githubusercontent.com/cloudposse-terraform-components/.github/refs/heads/main/atmos.README.md.submodule.gotmpl"
21+
output: "./src/modules/redis_cluster/README.md"
22+
terraform:
23+
source: ./src/modules/redis_cluster
24+
enabled: true
25+
format: "markdown table"
26+
show_providers: false
27+
show_inputs: true
28+
show_outputs: true
29+
sort_by: "name"
30+
hide_empty: false
31+
indent_level: 2
32+
33+
commands:
34+
- name: readme
35+
steps:
36+
- "atmos docs generate readme"
37+
- "atmos docs generate readme-simple"
38+
- "atmos docs generate readme-submodule"
39+
40+
- name: test
41+
commands:
42+
- name: "deploy"
43+
description: Deploy
44+
commands:
45+
- name: "dependencies"
46+
description: Deploy dependencies only
47+
steps:
48+
- "cd test"
49+
- "go test -timeout 1h --only-deploy-dependencies --skip-destroy-dependencies"
50+
51+
- name: "component"
52+
description: Deploy component only
53+
steps:
54+
- "cd test"
55+
- "go test -timeout 1h --skip-deploy-dependencies --skip-destroy-dependencies --skip-destroy-component"
56+
57+
- name: "assert"
58+
description: Run asserts
59+
steps:
60+
- "cd test"
61+
- "go test -timeout 1h --skip-deploy-dependencies --skip-destroy-dependencies --skip-deploy-component --skip-destroy-component"
62+
63+
- name: "destroy"
64+
description: Destroy
65+
steps:
66+
- "cd test"
67+
- "go test -timeout 1h --skip-deploy-dependencies --skip-deploy-component"
68+
69+
- name: "run"
70+
description: Run tests
71+
steps:
72+
- "cd test"
73+
- "go test -timeout 1h"

src/modules/redis_cluster/README.md

Lines changed: 85 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)