-
-
Notifications
You must be signed in to change notification settings - Fork 32
Use atmos instead of makefile #819
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
* master: Add Atmos installation step in GitHub Action (#820)
…nto atmos-replace-makefile * 'atmos-replace-makefile' of github.com:cloudposse/docs:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR migrates from build-harness/Makefile-based documentation generation to atmos-based tooling, as build-harness has been deprecated. The change modernizes the documentation generation workflow by replacing make readme
commands with atmos docs generate readme
commands and updating templates accordingly.
Key changes:
- Replace Makefile-based documentation generation with atmos commands across Python renderers
- Add atmos configuration files for modules, components, and GitHub actions
- Update README templates to support terraform-docs integration via atmos
- Remove deprecated build-harness Makefile
Reviewed Changes
Copilot reviewed 23 out of 25 changed files in this pull request and generated 3 comments.
Show a summary per file
File | Description |
---|---|
scripts/render-docs-for-github-actions.sh | Excludes additional GitHub action from documentation rendering |
scripts/render-docs-for-components.sh | Adds new component exclusions and debug logging |
scripts/docs-collator/templates/modules/terraform-docs.yml | Changes output from docs/terraform.md to README.md with inject mode |
scripts/docs-collator/templates/modules/readme.md | Removes includes datasource and adds terraform_docs section |
scripts/docs-collator/templates/modules/atmos.yaml | New atmos configuration for module documentation generation |
scripts/docs-collator/templates/github-actions/readme.md | Enhanced template with GitHub action inputs/outputs tables and escape functions |
scripts/docs-collator/templates/github-actions/atmos.yaml | New atmos configuration for GitHub action documentation |
scripts/docs-collator/component/renderer/yml.py | Replaces make commands with atmos commands for documentation generation |
scripts/docs-collator/component/renderer/templates/make/Makefile | Removes deprecated build-harness Makefile |
scripts/docs-collator/component/renderer/templates/components/yml/terraform-docs.yml | Removes template wrapper for terraform-docs output |
scripts/docs-collator/component/renderer/templates/components/yml/readme.md | Removes unused variables and adds terraform_docs section |
scripts/docs-collator/component/renderer/templates/components/yml/atmos.yaml | New atmos configuration for component documentation |
scripts/docs-collator/component/fetcher.py | Adds atmos.yaml fetching to component workflow |
scripts/docs-collator/ModuleRenderer.py | Replaces make readme with atmos docs generate readme command |
scripts/docs-collator/ModuleFetcher.py | Adds terraform file fetching and logging improvements |
scripts/docs-collator/GitHubActionRenderer.py | Migrates from make to atmos for GitHub action documentation |
scripts/docs-collator/GitHubActionFetcher.py | Adds action.yml and atmos.yaml fetching |
scripts/docs-collator/AbstractFetcher.py | Adds base atmos.yaml fetching functionality |
atmos.yaml | New atmos configuration importing shared settings |
README.yaml | Removes targets.md include reference |
README.md | Updates with new testing section and copyright year |
Makefile | Adds atmos-based readme generation targets |
.github/actions/build-website/action.yml | Adds atmos installation step |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please fix misspelled 'sanatize_string' instead of 'sanitize_string'
what
why