fix(toolkit): diff prints stack name not display name #454
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
kaizencc
commented
May 5, 2025
| @@ -154,7 +154,7 @@ export class DiffFormatter { | |||
| this.ioHelper = props.ioHelper; | |||
| this.oldTemplate = props.templateInfo.oldTemplate; | |||
| this.newTemplate = props.templateInfo.newTemplate; | |||
| this.stackName = props.templateInfo.newTemplate.stackName; | |||
| this.stackName = props.templateInfo.newTemplate.displayName ?? props.templateInfo.newTemplate.stackName; | |||
There was a problem hiding this comment.
this is kind of iffy, but i think its safe. diff formatter is using stack name to differentiate nested stacks, and i don't think nested stacks can have a display name clash.
stack.displayName is defined as this:
/**
* A string that represents this stack. Should only be used in user
* interfaces. If the stackName has not been set explicitly, or has been set
* to artifactId, it will return the hierarchicalId of the stack. Otherwise,
* it will return something like "<hierarchicalId> (<stackName>)"
*/
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #454 +/- ##
=======================================
Coverage 79.18% 79.18%
=======================================
Files 54 54
Lines 6912 6912
Branches 772 773 +1
=======================================
Hits 5473 5473
Misses 1421 1421
Partials 18 18
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:
|
rix0rrr
approved these changes
May 6, 2025
mrgrain
approved these changes
May 6, 2025
Signed-off-by: github-actions <[email protected]>
aws-cdk-automation
had a problem deploying
to
integ-approval
GitHub Actions
Failure
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.
Fixes #448
Prior to #301 we were using both
stackNameanddisplayNameinterchangably in different areas of the CLI. #301 chose to standardize tostackName. This PR changes that todisplayName.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license