@@ -127,6 +127,36 @@ it to the main branch.
127127 readme_enabled: true
128128` ` `
129129
130+ # ## Migrating from `v0` to `v1`
131+
132+ ` v1` use [atmos](https://atmos.tools/cli/commands/docs/generate) instead of [build-harness](https://github.com/cloudposse/build-harness).
133+ You can drop `Makefile` if you use it only for readme generation.
134+ To support atmos reaadme generation, you must create `atmos.yaml` config.
135+ The configuration depends on your repo - please follow this [documentation](https://atmos.tools/cli/commands/docs/generate)
136+
137+ Example :
138+
139+ ` ` ` yaml filename="atmos.yaml"
140+ docs:
141+ generate:
142+ readme:
143+ base-dir: .
144+ input:
145+ - "./README.yaml"
146+ template: "https://.../README.md.gotmpl"
147+ output: "./README.md"
148+ terraform:
149+ source: src/
150+ enabled: false
151+ format: "markdown"
152+ show_providers: false
153+ show_inputs: true
154+ show_outputs: true
155+ sort_by: "name"
156+ hide_empty: false
157+ indent_level: 2
158+ ` ` `
159+
130160
131161
132162
@@ -138,6 +168,7 @@ it to the main branch.
138168
139169| Name | Description | Default | Required |
140170|------|-------------|---------|----------|
171+ | atmos-version | The version of atmos to install | >= 1.175.0 | false |
141172| banner\_enabled | Enable banner generation | true | false |
142173| commit\_author | The author to use when committing changes. | readme-action 📖 <actions@github.com> | false |
143174| commit\_message | The commit message to use when committing changes. | chore : update README.md | false |
@@ -153,6 +184,7 @@ it to the main branch.
153184| repository\_description | GitHub repository description | | false |
154185| repository\_name | GitHub repository name in the `repository\_org` that hosts the banner templates | | false |
155186| repository\_org | GitHub organization or user name used for the banner templates | | false |
187+ | target | Configuration name | readme | true |
156188| token | GitHub API token (use a PAT if you need to trigger other actions) | ${{ github.token }} | false |
157189| validate\_readme | Validate the README.md file using markdown-link-check | true | false |
158190
@@ -287,7 +319,7 @@ under the License.
287319
288320All other trademarks referenced herein are the property of their respective owners.
289321---
290- Copyright © 2017-2024 [Cloud Posse, LLC](https://cpco.io/copyright)
322+ Copyright © 2017-2025 [Cloud Posse, LLC](https://cpco.io/copyright)
291323
292324
293325<a href="https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-github-actions/readme&utm_content=readme_footer_link"><img alt="README footer" src="https://cloudposse.com/readme/footer/img"/></a>
0 commit comments