add pager to describe config command @samtholiya (#1203)
## what- We are adding pager from https://github.com/charmbracelet/bubbletea
--pagerflag,ATMOS_PAGERenv boolean variable added to enable/disable pager if required- Normal View
- Help View
- When user presses
cto copy the contents
why
- Our demos do not render well without a pager. Everything scrolls by too fast.
references
Summary by CodeRabbit
-
New Features
- Introduced a terminal pager for configuration output, providing a scrollable, full-screen view with navigation, copy, and help features.
- Added support for configuring the pager via a new
settings.terminal.pagerstring setting andATMOS_PAGERenvironment variable. - Added a new persistent
pagerflag to the describe commands for controlling paging behavior.
-
Improvements
- Enhanced error handling and output formatting for configuration commands, including typed query evaluation and explicit format validation.
- Updated CLI flags and descriptions for improved clarity regarding pager behavior.
- Refined configuration loading and pager enablement logic with a flexible string-based pager setting and a method to check if the pager is enabled.
- Improved YAML and JSON output with syntax highlighting where possible.
-
Bug Fixes
- Fixed issues related to pager usage and provided clear debug messages when pager activation fails.
-
Tests
- Added comprehensive tests for pager functionality, configuration output handling, and error scenarios.
-
Chores
- Updated dependencies to explicitly list required modules.
fix: Acceptance Tests Snapshots @milldr (#1240)
## what - Regenerated snapshots for acceptance testswhy
- After merging #934 , the result of a test command changed because the content on the main branch changed. The test is still valid and simply needs an updated snapshot
references
Add tests for `!terraform.output`. Improve logging and error handling @aknysh (#1235)
## what- Add tests for
!terraform.output - Refactor code
- Improve logging and error handling
- Install OpenTofu in the GitHub actions for testing Atmos OpenTofu components
why
- Add more unit tests for the
!terraform.outputYAML function. Test!terraform.outputfor OpenTofutofucommand per component - Refactor code: move all
shellrelated functions topkg/utils/shell_utils.go - Replace the deprecated logging functions with
github.com/charmbracelet/log - Use structured errors for error handling
🚀 Enhancements
Support atmos docs generate feature natively @Listener430 (#934)
## whatThis PR introduces a new command to generate a README.md from one or more input sources defined at docs.generate.readme section of atmos.yaml. The command combines all local or remote YAML files specified at source and generates README.md at the working directory. In case the template contains terraform_docs key, the resultant README.md will also have a corresponding section rendered. By default terraform.format is set to markdown table, and can also be markdown, tfvars hcl, and tfvars json.
This command also aliases to “atmos generate docs”.
Run with atmos docs generate readme , e.g.
Examples of outputs
markdown table (preview)
markdown table (source)
markdown (preview)
markdown (source)
tfvars hcl (source)
tfvars json (source)
Testing
Refer to tests\test-cases\docs-generate.yaml
why
Have an option to run a command natively from within atmos (not using builld-harness repo)
references
- see DEV-2835
Summary by CodeRabbit
-
New Features
- Introduced a new CLI command to generate documentation artifacts (e.g., README files) from YAML inputs and templates, supporting merging multiple sources and injecting Terraform documentation.
- Added configuration options for documentation generation, including local and remote inputs, template selection, and Terraform-specific settings.
- Enabled flexible README generation workflows with support for both local and remote templates and data sources.
-
Documentation
- Added comprehensive user documentation for the new documentation generation command, including usage examples and configuration details.
- Updated CLI help and website docs to reflect the new command and its options.
-
Tests
- Added extensive automated and unit tests to verify documentation generation functionality, template rendering, and input merging.
-
Chores
- Updated dependencies to support new features and improve compatibility.
🤖 Automatic Updates
Bump the cicd group with 3 updates @[dependabot[bot]](https://github.com/apps/dependabot) (#1221)
Bumps the cicd group with 3 updates: [aquaproj/aqua-installer](https://github.com/aquaproj/aqua-installer), [tj-actions/changed-files](https://github.com/tj-actions/changed-files) and [jaxxstorm/action-install-gh-release](https://github.com/jaxxstorm/action-install-gh-release).Updates Sourced from aquaproj/aqua-installer's releases.
aquaproj/aqua-installer@v3.1.1...v3.1.2
#801 Update the bootstrap version of aqua to v2.48.1
[!CAUTION]
To install aqua v2.48.2-0 or later, please aqua-installer v3.1.2 or later
aquaproj/aqua-installer from 3.1.1 to 3.1.2
Release notes
v3.1.2
SHA256 Checksum
9a5afb16da7191fbbc0c0240a67e79eecb0f765697ace74c70421377c99f0423 aqua-installer
Fixes
Commits
5e54e5c fix: update the bootstrap version of aqua to v2.48.1 (#801)
ce9cb52 chore(deps): update dependency suzuki-shunsuke/cmdx to v2.0.1 (#800)
c83fbb2 chore(deps): update dependency aquaproj/aqua to v2.48.1 (#799)
7686c06 chore(deps): update dependency aquaproj/aqua to v2.48.0 (#798)
d0884d4 chore(deps): update dependency aquaproj/aqua to v2.47.1 (#797)
3ba063d chore(deps): update dependency aquaproj/aqua to v2.47.0 (#796)
fcc461a chore(deps): update mirror.gcr.io/golang docker tag to v1.24.2 (#795)
ff846d9 chore(deps): update dependency suzuki-shunsuke/cmdx to v2 (#794)
42922ff ci: Replace autofix-ci/action with suzuki-shunsuke/autofix-ci-action (#793)
0baaa05 chore(deps): update dependency suzuki-shunsuke/ghalint to v1.3.0 (#792)
Updates Sourced from tj-actions/changed-files's changelog.
Co-authored-by: github-actions[bot] (6f67ee9) - (github-actions[bot])
Co-authored-by: github-actions[bot]
Co-authored-by: Tonye Jack jtonye@ymail.com (27ae6b3) - (github-actions[bot])
Co-authored-by: github-actions[bot] (41e0de5) - (github-actions[bot])
Co-authored-by: github-actions[bot] (9457878) - (github-actions[bot])
... (truncated)
tj-actions/changed-files from d6e91a2266cdb9d62096cebf1e8546899c6aa18f to 5426ecc3f5c2b10effaefbd374f0abdc6a571b2f
Changelog
Changelog
46.0.5 - (2025-04-09)
⚙️ Miscellaneous Tasks
@types/node from 22.13.11 to 22.14.0 (#2517) (3d751f6) - (dependabot[bot])
⬆️ Upgrades
46.0.4 - (2025-04-03)
🐛 Bug Fixes
📚 Documentation
⬆️ Upgrades
46.0.3 - (2025-03-23)
🔄 Update
📚 Documentation
Commits
5426ecc chore(deps): bump actions/download-artifact from 4.2.1 to 4.3.0 (#2545)
513a44e chore(deps-dev): bump @types/node from 22.14.1 to 22.15.0 (#2544)
46e217d chore(deps): bump github/codeql-action from 3.28.15 to 3.28.16 (#2542)
c34c1c1 chore(deps): bump actions/setup-node from 4.3.0 to 4.4.0 (#2539)
52c3beb chore(deps-dev): bump ts-jest from 29.3.1 to 29.3.2 (#2536)
ea3010b chore(deps-dev): bump @types/node from 22.14.0 to 22.14.1 (#2537)
be393a9 remove: commit and push step from build job (#2538)
9b4bb2b chore(deps): bump tj-actions/branch-names from 8.1.0 to 8.2.1 (#2535)
9934ab3 chore(deps-dev): bump eslint-config-prettier from 10.1.1 to 10.1.2 (#2532)
db731a1 Upgraded to v46.0.5 (#2531)
Updates Sourced from jaxxstorm/action-install-gh-release's releases.
Full Changelog: jaxxstorm/action-install-gh-release@v1...v1.14.0
Full Changelog: jaxxstorm/action-install-gh-release@v1...v1.13.0
Full Changelog: jaxxstorm/action-install-gh-release@v1...v1.12.0
jaxxstorm/action-install-gh-release from 1.11.0 to 1.14.0
Release notes
v1.14.0
What's Changed
@t3hmrman in jaxxstorm/action-install-gh-release#108
v1.13.0
What's Changed
@Dr-Emann in jaxxstorm/action-install-gh-release#83
@gberche-orange in jaxxstorm/action-install-gh-release#77
@t3hmrman in jaxxstorm/action-install-gh-release#94
@jaxxstorm in jaxxstorm/action-install-gh-release#96
@renovate in jaxxstorm/action-install-gh-release#66
@types/node to ^20.8.8 by @renovate in jaxxstorm/action-install-gh-release#95
@types/node to ^20.17.6 by @renovate in jaxxstorm/action-install-gh-release#98
@renovate in jaxxstorm/action-install-gh-release#100
@pchalamet in jaxxstorm/action-install-gh-release#92
@dependabot in jaxxstorm/action-install-gh-release#97
@renovate in jaxxstorm/action-install-gh-release#101
@jaxxstorm in jaxxstorm/action-install-gh-release#105
@renovate in jaxxstorm/action-install-gh-release#104
New Contributors
@Dr-Emann made their first contribution in jaxxstorm/action-install-gh-release#83
@gberche-orange made their first contribution in jaxxstorm/action-install-gh-release#77
@t3hmrman made their first contribution in jaxxstorm/action-install-gh-release#94
@pchalamet made their first contribution in jaxxstorm/action-install-gh-release#92
v1.12.0
What's Changed
@damirka in jaxxstorm/action-install-gh-release#81
New Contributors
@damirka made their first contribution in jaxxstorm/action-install-gh-release#81
Commits
cd6b2b7 Merge pull request #108 from t3hmrman/feat=support-xz
512e8ca feat: support xz, refactor post download setup
7f2440a Merge pull request #104 from jaxxstorm/renovate/actions-checkout-4.x
cab2da8 Merge pull request #105 from jaxxstorm/dep_upd
66c24c6 update npm deps
363def8 Merge pull request #101 from jaxxstorm/renovate/actions-checkout-digest
19f5b40 chore(deps): update actions/checkout action to v4
f4c7d37 Merge pull request #97 from jaxxstorm/dependabot/npm_and_yarn/semver-6.3.1
97ca0c8 Merge pull request #92 from MagnusOpera/feature/prerelease
cbf139e Merge pull request #100 from jaxxstorm/renovate/eslint-monorepo
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
@dependabot rebasewill rebase this PR@dependabot recreatewill recreate this PR, overwriting any edits that have been made to it@dependabot mergewill merge this PR after your CI passes on it@dependabot squash and mergewill squash and merge this PR after your CI passes on it@dependabot cancel mergewill cancel a previously requested merge and block automerging@dependabot reopenwill reopen this PR if it is closed@dependabot closewill close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually@dependabot show <dependency name> ignore conditionswill show all of the ignore conditions of the specified dependency@dependabot ignore <dependency name> major versionwill close this group update PR and stop Dependabot creating any more for the specific dependency's major version (unless you unignore this specific dependency's major version or upgrade to it yourself)@dependabot ignore <dependency name> minor versionwill close this group update PR and stop Dependabot creating any more for the specific dependency's minor version (unless you unignore this specific dependency's minor version or upgrade to it yourself)@dependabot ignore <dependency name>will close this group update PR and stop Dependabot creating any more for the specific dependency (unless you unignore this specific dependency or upgrade to it yourself)@dependabot unignore <dependency name>will remove all of the ignore conditions of the specified dependency@dependabot unignore <dependency name> <ignore condition>will remove the ignore condition of the specified dependency and ignore conditions





