Skip to content

Conversation

@goruha
Copy link
Contributor

@goruha goruha commented May 23, 2025

what

  • Use atmos to generate readme

why

  • Build-harness is depricated

Migrating from v0 to v1

v1 use atmos instead of build-harness.
You can drop Makefile if you use it only for readme generation.
To support atmos reaadme generation, you must create atmos.yaml config.
The configuration depends on your repo - please follow this documentation
Example:

docs:
  generate:
    readme:
      base-dir: .
      input:
        - "./README.yaml"
      template: "https://.../README.md.gotmpl"
      output: "./README.md"
      terraform:
        source: src/
        enabled: false
        format: "markdown"
        show_providers: false
        show_inputs: true
        show_outputs: true
        sort_by: "name"
        hide_empty: false
        indent_level: 2

@goruha goruha added the major Breaking changes (or first stable release) label May 23, 2025
Benbentwo
Benbentwo previously approved these changes May 23, 2025
@goruha goruha requested a review from Benbentwo May 26, 2025 16:54
@goruha goruha merged commit df1cc86 into main May 26, 2025
8 checks passed
@goruha goruha deleted the use-atmos-to-generate-readme branch May 26, 2025 18:56
@github-actions
Copy link

These changes were released in v1.0.0.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

major Breaking changes (or first stable release)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants