Update atmos describe affected command
#1267
Conversation
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
pkg/atlantis/atlantis_generate_repo_config_test.go (1)
80-83: Good fix for path resolution in test environments.This change properly addresses the path resolution issue when tests run in temporary directories. The explicit override ensures the configuration points to the correct fixture location regardless of where the test is executed.
Consider using
filepath.Joinor similar path utilities for better cross-platform compatibility:- atmosConfig.BasePath = "./tests/fixtures/scenarios/complete" + atmosConfig.BasePath = filepath.Join(".", "tests", "fixtures", "scenarios", "complete")
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pkg/atlantis/atlantis_generate_repo_config_test.go(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: Build (windows-latest, windows)
- GitHub Check: Summary
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #1267 +/- ##
==========================================
+ Coverage 48.40% 49.14% +0.74%
==========================================
Files 233 233
Lines 25505 25497 -8
==========================================
+ Hits 12345 12531 +186
+ Misses 11554 11305 -249
- Partials 1606 1661 +55
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
website/docs/cli/commands/describe/describe-affected.mdx (3)
396-396: Typographical: consider using an em dash
To join two clauses or introduce an example, replace the hyphen after "affected" with an em dash for better readability:- `affected` - shows the first (in the processing order) section that was changed. + `affected` — shows the first (in the processing order) section that was changed.🧰 Tools
🪛 LanguageTool
[typographical] ~396-~396: To join two clauses or introduce examples, consider using an em dash.
Context: ...other affected component -affected- shows the first (in the processing order...(DASH_RULE)
598-598: Typographical: em dash for definition
Similarly, use an em dash in theaffected_allbullet for consistency:- `affected_all` - shows all component sections and attributes that were changed + `affected_all` — shows all component sections and attributes that were changed🧰 Tools
🪛 LanguageTool
[typographical] ~598-~598: To join two clauses or introduce examples, consider using an em dash.
Context: ... } ] ``` -affected_all- shows all component sections and attribu...(DASH_RULE)
600-617: Align JSON example indentation
In the example output, the indentation of theaffected_allarray items is inconsistent (one item is indented with 12 spaces, the other with 13). Consider normalizing both to two-space indentation within the block for consistency:- "affected_all": [ - "stack.vars", - "stack.settings" - ] + "affected_all": [ + "stack.vars", + "stack.settings" + ]🧰 Tools
🪛 LanguageTool
[style] ~600-~600: Consider shortening or rephrasing this to strengthen your wording.
Context: ...t were changed For example, if you make changes to thevarsandsettingssections of t...(MAKE_CHANGES)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
website/docs/cli/commands/describe/describe-affected.mdx(14 hunks)
🧰 Additional context used
🪛 LanguageTool
website/docs/cli/commands/describe/describe-affected.mdx
[typographical] ~396-~396: To join two clauses or introduce examples, consider using an em dash.
Context: ...other affected component - affected - shows the first (in the processing order...
(DASH_RULE)
[typographical] ~598-~598: To join two clauses or introduce examples, consider using an em dash.
Context: ... } ] ``` - affected_all - shows all component sections and attribu...
(DASH_RULE)
[style] ~600-~600: Consider shortening or rephrasing this to strengthen your wording.
Context: ...t were changed For example, if you make changes to the vars and settings sections of t...
(MAKE_CHANGES)
⏰ Context from checks skipped due to timeout of 90000ms (6)
- GitHub Check: Build (windows-latest, windows)
- GitHub Check: Lint (golangci)
- GitHub Check: Build (ubuntu-latest, linux)
- GitHub Check: website-deploy-preview
- GitHub Check: Analyze (go)
- GitHub Check: Summary
🔇 Additional comments (4)
website/docs/cli/commands/describe/describe-affected.mdx (4)
203-316: Readable definition list for flags
The conversion of the flags section from a table to a definition list (<dl>,<dt>,<dd>) enhances clarity and makes it easier to scan flag names and descriptions. Great improvement for maintainability.
343-343: Document newaffected_allfield in output schema
The JSON schema has been updated to include"affected_all": []. Ensure the accompanying description below clearly explains its purpose.
619-637: Example for new component is clear
The scenario demonstrating a newly created component and itsaffected_allentries is well-written and informative.
679-683: Clarify exclusion of abstract and disabled components
Good addition to note that abstract (metadata.type) and disabled (metadata.enabled) components are excluded. This addresses user expectations directly.
|
Warning This PR exceeds the recommended limit of 1,000 lines.Large PRs are difficult to review and may be rejected due to their size. Please verify that this PR does not address multiple issues. |
|
These changes were released in v1.177.0. |
what
atmos describe affectedcommandaffected_allattribute to the output ofatmos describe affectedto show all component sections and attributes that were changedwhy
Improve usage of the
atmos describe affectedcommand in CI/CD, e.g. GitHub actionsaffected_allwill allow detecting everything that was changed for a component in a stack (including Terraform configurations/components/modules) and ack on the changesFor example, if you make changes to the
varsandsettingssections of the componentcomponent-1in thenonprodstack, and executeatmos describe affected, you will get the following result:[ { "component": "component-1", "component_type": "terraform", "stack": "nonprod", "stack_slug": "nonprod-component-1", "affected": "stack.vars", "affected_all": [ "stack.vars", "stack.settings" ] } ]If you create a new Terraform/Tofu component, configure a new Atmos component
component-1in thenonprodstack, and executeatmos describe affected, you will get the following result:[ { "component": "component-1", "component_type": "terraform", "stack": "nonprod", "stack_slug": "nonprod-component-1", "affected": "stack.metadata", "affected_all": [ "component", "stack.metadata", "stack.vars", "stack.env", "stack.settings" ] } ]where:
affectedshows that the Atmos component'smetadatasection was changed(since the component is new and the
metadatasection is the first section that Atmos processes)affected_allshows all the affected sections and attributes:component- the Terraform component (Terraform configuration) was affected (since it was just added)stack.metadata- the Atmos component'smetadatasection was changedstack.vars- the Atmos component'svarssection was changedstack.env- the Atmos component'senvsection was changedstack.settings- the Atmos component'ssettingssection was changedSummary by CodeRabbit
New Features
affected_all, to the output of thedescribe affectedcommand, providing a list of all changed sections for affected components and stacks.Bug Fixes
Documentation
affected_allattribute, with revised examples and clarifications.Tests
describe affectedcommand to verify correct behavior and output.Refactor