fix: Log messages as YAML comments #434
Merged
Conversation
This file contains 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
When a stack is synthesized, AWS CDK will: - print the resulting CloudFormation template as YAML to the console - save the resulting CloudFormation template as JSON to disk The AWS CDK library does not support synthesizing a YAML template to disk. The only way to achieve this is is to redirect the result of `cdk synth` to disk. For example: ```console cdk synth > cloudformation.yaml ``` Since #364 we have started printing important messages to the console. This breaks the saving YAML to disk trick as the file on disk is not valid YAML. For example: ```yaml GuStack has 'migratedFromCloudFormation' set to false. MyDatabase is a stateful construct, it's logicalId will be auto-generated and AWS will create a new resource. Parameters: Stage: Type: String Default: CODE AllowedValues: - CODE - PROD Description: Stage name Resources: MyDatabaseA1B2C3D4: Type: AWS::RDS::DBInstance ``` For this reason, prefix console messages with "# ". This results in `cloudformation.yaml` still being valid YAML. For example: ```yaml \# GuStack has 'migratedFromCloudFormation' set to false. MyDatabase is a stateful construct, it's logicalId will be auto-generated and AWS will create a new resource. Parameters: Stage: Type: String Default: CODE AllowedValues: - CODE - PROD Description: Stage name Resources: MyDatabaseA1B2C3D4: Type: AWS::RDS::DBInstance ```
jacobwinch
approved these changes
Apr 13, 2021
|
🎉 This PR is included in version 8.1.3 🎉 The release is available on: Your semantic-release bot 📦🚀 |
akash1810
added a commit
that referenced
this pull request
May 7, 2021
Use AWS CDK Annotations to log messages instead of our custom Logger. Annotations have coloured output (info = white, warning = yellow, error = red). They also work with the `--trace`, `--strict` and `--ignore-errors` flags of the CDK CLI. Note, we don't need to employ the trick in #434 as Annotations (somehow) do not get piped to disk if one redirects output to disk. Before: ```console ➜ npx cdk synth --strict --path-metadata false --version-reporting false \# GuStack has 'migratedFromCloudFormation' set to false. MySnsTopic is a stateful construct, it's logicalId will be auto-generated and AWS will create a new resource. Parameters: Stage: Type: String Default: CODE AllowedValues: - CODE - PROD Description: Stage name ``` After: ``` ➜ npx cdk synth --strict --path-metadata false --version-reporting false [Info at /CdkPlayground/MySnsTopic] GuStack has 'migratedFromCloudFormation' set to false. MySnsTopic is a stateful construct, it's logicalId will be auto-generated and AWS will create a new resource. Parameters: Stage: Type: String Default: CODE AllowedValues: - CODE - PROD Description: Stage name ``` See: - https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_core.Annotations.html
akash1810
added a commit
that referenced
this pull request
May 7, 2021
Use AWS CDK Annotations to log messages instead of our custom Logger. Annotations have coloured output (info = white, warning = yellow, error = red). They also work with the `--trace`, `--strict` and `--ignore-errors` flags of the CDK CLI. Note, we don't need to employ the trick in #434 as Annotations (somehow) do not get piped to disk if one redirects output to disk. Before: ```console ➜ npx cdk synth --strict --path-metadata false --version-reporting false # GuStack has 'migratedFromCloudFormation' set to false. MySnsTopic is a stateful construct, it's logicalId will be auto-generated and AWS will create a new resource. Parameters: Stage: Type: String Default: CODE AllowedValues: - CODE - PROD Description: Stage name ``` After: ```console ➜ npx cdk synth --strict --path-metadata false --version-reporting false [Info at /CdkPlayground/MySnsTopic] GuStack has 'migratedFromCloudFormation' set to false. MySnsTopic is a stateful construct, it's logicalId will be auto-generated and AWS will create a new resource. Parameters: Stage: Type: String Default: CODE AllowedValues: - CODE - PROD Description: Stage name ``` See: - https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_core.Annotations.html
akash1810
added a commit
that referenced
this pull request
May 10, 2021
Use AWS CDK Annotations to log messages instead of our custom Logger. Annotations have coloured output (info = white, warning = yellow, error = red). They also work with the `--trace`, `--strict` and `--ignore-errors` flags of the CDK CLI. Note, we don't need to employ the trick in #434 as Annotations (somehow) do not get piped to disk if one redirects output to disk. Before: ```console ➜ npx cdk synth --strict --path-metadata false --version-reporting false # GuStack has 'migratedFromCloudFormation' set to false. MySnsTopic is a stateful construct, it's logicalId will be auto-generated and AWS will create a new resource. Parameters: Stage: Type: String Default: CODE AllowedValues: - CODE - PROD Description: Stage name ``` After: ```console ➜ npx cdk synth --strict --path-metadata false --version-reporting false [Info at /CdkPlayground/MySnsTopic] GuStack has 'migratedFromCloudFormation' set to false. MySnsTopic is a stateful construct, it's logicalId will be auto-generated and AWS will create a new resource. Parameters: Stage: Type: String Default: CODE AllowedValues: - CODE - PROD Description: Stage name ``` See: - https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_core.Annotations.html
2 tasks
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.
What does this change?
When a stack is synthesized, AWS CDK will:
The AWS CDK library does not support synthesizing a YAML template to disk. The only way to achieve this is is to redirect the result of
cdk synthto disk.For example:
cdk synth > cloudformation.yamlSince #364 we have started printing important messages to the console. This breaks the saving YAML to disk trick as the file on disk is not valid YAML.
For example:
For this reason, prefix console messages with "# ". This results in
cloudformation.yamlstill being valid YAML.For example:
See:
Does this change require changes to existing projects or CDK CLI?
No.
How to test
Not sure. Help wanted!
Was thinking the integration-test however not sure how to write the test.
How can we measure success?
The redirect trick to save a YAML template works.
Have we considered potential risks?
n/a