feat(cloud-assembly-schema): add preamble feature, document contract#1735
Merged
Conversation
Currently, if there are CloudFormation Validate warnings that the CDK app wants to attach a notification to, it has no option other than to print directly to the console, which interferes with stdout/stderr handling of the CLI. Add a `preamble?: string` feature to the validation reports which the app can use to ask the CLI to print a user-friendly message. Also document the missing contract of `templatePath` in the validation of what the path should be relative to; there didn't use to be a contract for it but the only value that makes sense is to have it be relative to the assembly root. The app already encodes this behavior but we document it explicitly here.
Contributor
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1735 +/- ##
==========================================
+ Coverage 89.57% 89.59% +0.01%
==========================================
Files 77 78 +1
Lines 11758 11790 +32
Branches 1651 1655 +4
==========================================
+ Hits 10532 10563 +31
- Misses 1197 1198 +1
Partials 29 29
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
rix0rrr
changed the title
ShadowCat567
approved these changes
Jul 17, 2026
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
4 participants
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.
Currently, if there are CloudFormation Validate warnings that the CDK app wants to attach a notification to, it has no option other than to print directly to the console, which interferes with stdout/stderr handling of the CLI.
Add a
preamble?: stringfeature to the validation reports which the app can use to ask the CLI to print a user-friendly message.Also document the missing contract of
templatePathin the validation of what the path should be relative to; there didn't use to be a contract for it but the only value that makes sense is to have it be relative to the assembly root. The app already encodes this behavior but we document it explicitly here.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license