Skip to content

feat(cli): allow diffing against a processed template#19908

Merged
mergify[bot] merged 3 commits intoaws:mainfrom
skinny85:diff-processed-template
Jul 14, 2022
Merged

feat(cli): allow diffing against a processed template#19908
mergify[bot] merged 3 commits intoaws:mainfrom
skinny85:diff-processed-template

Conversation

@skinny85
Copy link
Copy Markdown
Contributor

@skinny85 skinny85 commented Apr 14, 2022

In some cases, using an unprocessed template with CfnInclude fails,
most commonly because the unprocessed template can contain cycles between the resources.
When this happens, customers need to include the processed template instead,
but when that happens, the diff command returns the wrong results,
because it compares against the original, and thus unprocessed, template.

Add a new command-line switch to the diff command that allows comparing against the processed template,
which gives the correct results in this case.


All Submissions:

Adding new Unconventional Dependencies:

  • This PR adds new unconventional dependencies following the process described here

New Features

  • Have you added the new feature to an integration test?
    • Did you use yarn integ to deploy the infrastructure and generate the snapshot (i.e. yarn integ without --dry-run)?

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

In some cases, using an unprocessed template with `CfnInclude` fails,
most commonly because the unprocessed template can contain cycles between the resources.
When this happens, customers need to include the processed template instead,
but when that happens, the `diff` command returns the wrong results,
because it compares against the original, and thus unprocessed, template.

Add a new command-line switch to the `diff` command that allows comparing against the processed template,
which gives the correct results in this case.
@skinny85 skinny85 requested a review from rix0rrr April 14, 2022 02:34
@gitpod-io
Copy link
Copy Markdown

gitpod-io bot commented Apr 14, 2022

@github-actions github-actions bot added the p2 label Apr 14, 2022
@aws-cdk-automation aws-cdk-automation requested a review from a team April 14, 2022 02:34
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Apr 14, 2022
@skinny85 skinny85 added the pr-linter/exempt-integ-test The PR linter will not require integ test changes label Apr 14, 2022
@comcalvi comcalvi added the pr/do-not-merge This PR should not be merged at this time. label Apr 21, 2022
Copy link
Copy Markdown
Contributor

@comcalvi comcalvi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! adding do-not-merge so @rix0rrr can take a look.

@skinny85
Copy link
Copy Markdown
Contributor Author

@rix0rrr would appreciate a look here 🙂.

@comcalvi comcalvi changed the base branch from v1-main to main June 15, 2022 00:06
@TheRealAmazonKendra TheRealAmazonKendra removed the contribution/core This is a PR that came from AWS. label Jul 14, 2022
@comcalvi comcalvi removed the pr/do-not-merge This PR should not be merged at this time. label Jul 14, 2022
@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Jul 14, 2022

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@aws-cdk-automation
Copy link
Copy Markdown
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: bfe88e4
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@mergify mergify bot merged commit cd4851a into aws:main Jul 14, 2022
@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Jul 14, 2022

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

guessi pushed a commit to guessi/aws-cdk that referenced this pull request Jul 17, 2022
In some cases, using an unprocessed template with `CfnInclude` fails,
most commonly because the unprocessed template can contain cycles between the resources.
When this happens, customers need to include the processed template instead,
but when that happens, the `diff` command returns the wrong results,
because it compares against the original, and thus unprocessed, template.

Add a new command-line switch to the `diff` command that allows comparing against the processed template,
which gives the correct results in this case.

----

### All Submissions:

* [x] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/master/CONTRIBUTING.md)

### Adding new Unconventional Dependencies:

* [ ] This PR adds new unconventional dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/master/CONTRIBUTING.md/#adding-new-unconventional-dependencies)

### New Features

* [ ] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/master/INTEGRATION_TESTS.md)?
	* [ ] Did you use `yarn integ` to deploy the infrastructure and generate the snapshot (i.e. `yarn integ` without `--dry-run`)?

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
@skinny85 skinny85 deleted the diff-processed-template branch August 12, 2022 03:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

p2 pr-linter/exempt-integ-test The PR linter will not require integ test changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants