Add template architecture diagram workflow#150
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This pull request adds the template architecture diagram workflow for ROS/IaC templates and integrates it into the interactive REPL Step 4 experience.
The main changes are:
Motivation
The previous template architecture diagram feature produced a single rough Mermaid diagram with limited resource semantics. For realistic ROS templates this often made diagrams too long, too wide, or visually confusing, and it could miss important architecture relationships such as VPC/CEN connectivity, load balancing paths, attached resources, or compact configuration resources.
This change improves the feature from the result perspective:
User Impact
For interactive users:
For headless / protocol users:
Implementation Notes
_iac_code_tool_renderand externalized-result metadata before emitting headless output.termaidas a runtime optional import so Python 3.10 static lint/type checks do not require the Python 3.11-only diagram extra.Validation
Local validation run before opening the PR:
make testResult:
Additional local validation after fixing the CI lint failure:
Result:
The push also ran the repository pre-push hook and AK leak detection, which completed without finding data that needed scanning.
Risks and Follow-up