feat(description): add first-class description field to components and stacks via metadata.description#2200
feat(description): add first-class description field to components and stacks via metadata.description#2200
description field to components and stacks via metadata.description#2200Conversation
…d stacks - Add DescriptionSectionName constant to pkg/config/const.go - Extract and propagate description in stack_processor_process_stacks.go at stack level - Extract ComponentDescription in stack_processor_process_stacks_helpers_extraction.go - Add ComponentDescription to ComponentProcessorResult struct - Add description to final comp map in stack_processor_merge.go - Add description to all 4 component type loops in describe_stacks.go (terraform/helmfile/packer/ansible) - Add setStackDescription helper for stack-level description surfacing - Fix empty stacks filter to use sections filter for relevance check - Add description to FilterComputedFields whitelist in describe_component.go - Update 3 JSON schema files with description field for components and stacks - Add description to top-level-component1 and us-east-2 test fixtures - Add 4 unit tests for description field support Co-authored-by: nitrocode <7775707+nitrocode@users.noreply.github.com>
…blog post - Add description to default checkSections list to prevent pruning components with only description - Remove speculative template variable example from blog post - Add stack-config schema (stacks/stack-config/1.0.json) with description field Co-authored-by: nitrocode <7775707+nitrocode@users.noreply.github.com>
description field to components and stacks
Dependency Review✅ No vulnerabilities or license issues found.Snapshot WarningsEnsure that dependencies are being submitted on PR branches and consider enabling retry-on-snapshot-warnings. See the documentation for more information and troubleshooting advice. Scanned FilesNone |
This comment was marked as outdated.
This comment was marked as outdated.
Co-authored-by: nitrocode <7775707+nitrocode@users.noreply.github.com>
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
…cribe component output Co-authored-by: nitrocode <7775707+nitrocode@users.noreply.github.com>
This comment was marked as outdated.
This comment was marked as outdated.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2200 +/- ##
==========================================
+ Coverage 77.21% 77.27% +0.05%
==========================================
Files 1018 1018
Lines 96368 96392 +24
==========================================
+ Hits 74415 74484 +69
+ Misses 17755 17709 -46
- Partials 4198 4199 +1
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
This comment was marked as outdated.
This comment was marked as outdated.
website/blog/2026-03-15-description-field-on-components-and-stacks.mdx
Outdated
Show resolved
Hide resolved
This comment was marked as outdated.
This comment was marked as outdated.
Resolved in df8a763. Merged main (38 commits ahead, including PR #2204's major refactor of Conflict resolution:
Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
This comment was marked as outdated.
This comment was marked as outdated.
1. Fix compile error: declare stackDescription in processStackFile 2. Gofmt already applied by autofix.ci (no-op) 3. Fix vacuous test in TestDescribeStacksNoDescriptionField 4. Add TestDescribeStacksHelmfileComponentDescription for coverage 5. Add CLI golden snapshot for --sections description filter" Co-authored-by: nitrocode <7775707+nitrocode@users.noreply.github.com> Agent-Logs-Url: https://github.com/cloudposse/atmos/sessions/6d2569f8-5d96-49fa-89ae-bc60931eebd3
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
- Move description application into processComponentEntry so it's order-independent when multiple files contribute to the same stack name - Stamp description immediately on pre-created entries (includeEmptyStacks path) - Remove the fragile existingStacks snapshot approach - Add regression test TestProcessStackFile_DescriptionOnPreCreatedEntry - Fix blog post author: change [rb] to [atmos]" Agent-Logs-Url: https://github.com/cloudposse/atmos/sessions/a22ac351-da61-40f2-b79a-2cf9ff77a3ed Co-authored-by: nitrocode <7775707+nitrocode@users.noreply.github.com>
This comment was marked as outdated.
This comment was marked as outdated.
|
Tip For best results, initiate chat on the files or code changes. 🧩 Analysis chain🏁 Script executed: Length of output: 6685 🏁 Script executed: Length of output: 6048 🏁 Script executed: Length of output: 372 🏁 Script executed: Length of output: 4695 🏁 Script executed: Length of output: 1030 🏁 Script executed: Length of output: 4382 🏁 Script executed: Length of output: 1739 🏁 Script executed: Length of output: 962 🏁 Script executed: Length of output: 2803 🏁 Script executed: Length of output: 1682 🏁 Script executed: Length of output: 4096 🏁 Script executed: Length of output: 1283
1. Executive SummaryRound 4 shows material progress: the 2. Findings Table
3. Scores Table
4. Top 5 Copilot Action Items
5. Suggested Fix Prompt🧠 Learnings used |
…n tests - Add windowsTerraformWait() helper in yaml_func_terraform_output_test.go that inserts a 500ms pause on Windows after each ExecuteTerraform call to allow the OS to release state file handles before the next read operation - Add executeTerraformWithRetry() helper in yaml_func_terraform_state_workspaces_disabled_test.go that retries the deploy up to 3 times with 500ms delays on Windows to handle transient state lock errors - Use executeTerraformWithRetry in TestWorkspacesDisabledStateLocation All tests in the package share the same mock-component directory (tests/fixtures/components/terraform/mock), so Windows file-locking semantics can cause TestYamlFuncTerraformOutput and TestWorkspacesDisabledStateLocation to fail with "file locked by another process" when Terraform processes from prior tests still hold handles on the state file. Agent-Logs-Url: https://github.com/cloudposse/atmos/sessions/67ad4c8f-fd75-4853-ad15-cfb55b25993a Co-authored-by: nitrocode <7775707+nitrocode@users.noreply.github.com>
Fixed in 3e6f7ae. The Windows acceptance tests ( |
processComponentEntry(order-independent, idempotent) and stamp pre-created entries immediately[rb]to[atmos]TestProcessStackFile_DescriptionOnPreCreatedEntry📱 Kick off Copilot coding agent tasks wherever you are with GitHub Mobile, available on iOS and Android.