fix(toolkit-lib)!: diff message payloads are incomplete #546
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
mrgrain
changed the title
mrgrain
commented
May 28, 2025
| @@ -71,7 +71,7 @@ interface FormatStackDiffOptions { | |||
| * | |||
| * @default 3 | |||
| */ | |||
| readonly context?: number; | |||
| readonly contextLines?: number; | |||
There was a problem hiding this comment.
This just makes the calling a little nicer.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #546 +/- ##
=======================================
Coverage 79.10% 79.10%
=======================================
Files 47 47
Lines 7074 7074
Branches 794 793 -1
=======================================
Hits 5596 5596
Misses 1457 1457
Partials 21 21
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:
|
mrgrain
commented
May 28, 2025
Comment on lines
+181
to
+182
| private permissionType(): PermissionChangeType { | ||
| const diff = this.diff(); |
There was a problem hiding this comment.
Cleanup. permissionType is never called with a stackName. Let's not pretend it should.
mrgrain
changed the title
otaviomacedo
approved these changes
May 28, 2025
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 #494
The messages emitted as part of diff were incomplete when multiple stacks are diffed. Previously the code would overwrite the formatted output with the last processed stack. We are also removing the already deprecated
securityOnlyoption.To solve this properly, the diff messages have been restructured: For each stack we emit a new message with code
CDK_TOOLKIT_I4002that contains all formatted diffs for the stack (including any nested stacks).The collated result message
CDK_TOOLKIT_I4001does not contain formatted diffs anymore, but instead has a count for stacks with changes and the structured diff as returned by the action.BREAKING CHANGE: The data emitted by message
CDK_TOOLKIT_I4001has changed. Instead of formatted diffs, it now contains a stack count and the template diff as returned by the action. The formatted output is now available on a new messageCDK_TOOLKIT_I4002. Deprecated optionsecurityOnlyremoved fromDiffOptionsused byToolkit.diff(). Instead the action always prints and returns a security diff. Use a customIoHostimplementation to customize the exact diff output.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license