terraform-yaml-stack-config/atmos.yaml at main · cloudposse/terraform-yaml-stack-config · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
# Atmos Configuration — powered by https://atmos.tools
#
# This configuration enables centralized, DRY, and consistent project scaffolding using Atmos.
#
# Included features:
# - Organizational custom commands: https://atmos.tools/core-concepts/custom-commands
# - Automated README generation: https://atmos.tools/cli/commands/docs/generate
#

# Import shared configuration used by all modules
import:
  - https://raw.githubusercontent.com/cloudposse/.github/refs/heads/main/.github/atmos/terraform-module.yaml

docs:
  generate:
    readme-submodule-backend:
      base-dir: ./
      input:
        - readme: "./modules/backend/README.md"
        - get_support: true
      template: "https://raw.githubusercontent.com/cloudposse/.github/refs/heads/main/atmos.README.md.submodule.gotmpl"
      output: "./modules/backend/README.md"
      terraform:
        source: ./modules/backend
        enabled: true
        format: "markdown table"
        show_providers: false
        show_inputs: true
        show_outputs: true
        sort_by: "name"
        hide_empty: false
        indent_level: 2

    readme-submodule-env:
      base-dir: ./
      input:
        - readme: "./modules/env/README.md"
        - get_support: true
      template: "https://raw.githubusercontent.com/cloudposse/.github/refs/heads/main/atmos.README.md.submodule.gotmpl"
      output: "./modules/env/README.md"
      terraform:
        source: ./modules/env
        enabled: true
        format: "markdown table"
        show_providers: false
        show_inputs: true
        show_outputs: true
        sort_by: "name"
        hide_empty: false
        indent_level: 2

    readme-submodule-remote-state:
      base-dir: ./
      input:
        - readme: "./modules/remote-state/README.md"
        - get_support: true
      template: "https://raw.githubusercontent.com/cloudposse/.github/refs/heads/main/atmos.README.md.submodule.gotmpl"
      output: "./modules/remote-state/README.md"
      terraform:
        source: ./modules/remote-state
        enabled: true
        format: "markdown table"
        show_providers: false
        show_inputs: true
        show_outputs: true
        sort_by: "name"
        hide_empty: false
        indent_level: 2

    readme-submodule-settings:
      base-dir: ./
      input:
        - readme: "./modules/settings/README.md"
        - get_support: true
      template: "https://raw.githubusercontent.com/cloudposse/.github/refs/heads/main/atmos.README.md.submodule.gotmpl"
      output: "./modules/settings/README.md"
      terraform:
        source: ./modules/settings
        enabled: true
        format: "markdown table"
        show_providers: false
        show_inputs: true
        show_outputs: true
        sort_by: "name"
        hide_empty: false
        indent_level: 2

    readme-submodule-spacelift:
      base-dir: ./
      input:
        - readme: "./modules/spacelift/README.md"
        - get_support: true
      template: "https://raw.githubusercontent.com/cloudposse/.github/refs/heads/main/atmos.README.md.submodule.gotmpl"
      output: "./modules/spacelift/README.md"
      terraform:
        source: ./modules/spacelift
        enabled: true
        format: "markdown table"
        show_providers: false
        show_inputs: true
        show_outputs: true
        sort_by: "name"
        hide_empty: false
        indent_level: 2

    readme-submodule-stack:
      base-dir: ./
      input:
        - readme: "./modules/stack/README.md"
        - get_support: true
      template: "https://raw.githubusercontent.com/cloudposse/.github/refs/heads/main/atmos.README.md.submodule.gotmpl"
      output: "./modules/stack/README.md"
      terraform:
        source: ./modules/stack
        enabled: true
        format: "markdown table"
        show_providers: false
        show_inputs: true
        show_outputs: true
        sort_by: "name"
        hide_empty: false
        indent_level: 2

    readme-submodule-vars:
      base-dir: ./
      input:
        - readme: "./modules/vars/README.md"
        - get_support: true
      template: "https://raw.githubusercontent.com/cloudposse/.github/refs/heads/main/atmos.README.md.submodule.gotmpl"
      output: "./modules/vars/README.md"
      terraform:
        source: ./modules/vars
        enabled: true
        format: "markdown table"
        show_providers: false
        show_inputs: true
        show_outputs: true
        sort_by: "name"
        hide_empty: false
        indent_level: 2


commands:
- name: readme
  steps:
    - "atmos docs generate readme"
    - "atmos docs generate readme-submodule-backend"
    - "atmos docs generate readme-submodule-env"
    - "atmos docs generate readme-submodule-remote-state"
    - "atmos docs generate readme-submodule-settings"
    - "atmos docs generate readme-submodule-spacelift"
    - "atmos docs generate readme-submodule-stack"
    - "atmos docs generate readme-submodule-vars"

- name: test
  commands:
  - name: "init"
    description: Initialize tests
    steps:
      - "make -C test/src init"

  - name: "run"
    description: Run tests
    steps:
      - "cd test/src && go mod tidy"
      - "cd test/src && go test -v -timeout 60m"

  - name: "clean"
    description: Clean tests
    steps:
      - "make -C test/src clean"
      - "rm -rf examples/*/.terraform examples/*/.terraform.lock.hcl"