Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(core): add option to suppress indentation in templates #25892

Merged
merged 5 commits into from
Jun 15, 2023
Merged

feat(core): add option to suppress indentation in templates #25892

merged 5 commits into from
Jun 15, 2023

Conversation

jesterhazy
Copy link
Contributor

Fixes #18694, #8712

This change adds an option to suppress indentation in CloudFormation template files. Suppressing indentation will reduce the file size of templates.

Indentation can be set by enabling for specific Stacks using the new suppressTemplateIndentation property in StackProps, or globally using the new @aws-cdk/core:suppressTemplateIndentation context key.

This PR provides additional template size reduction beyond the indentation change in #19656.

@rix0rrr @mackalex @PatMyron


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

@gitpod-io
Copy link

gitpod-io bot commented Jun 7, 2023

@aws-cdk-automation aws-cdk-automation requested a review from a team June 7, 2023 17:54
@github-actions github-actions bot added effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. p2 beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK labels Jun 7, 2023
@jesterhazy
Copy link
Contributor Author

note: integration tests have NOT been run

Copy link
Collaborator

@aws-cdk-automation aws-cdk-automation left a comment

Choose a reason for hiding this comment

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

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

@jesterhazy
Copy link
Contributor Author

Exemption Request: this change doesn't seem to warrant an integration test.

@aws-cdk-automation aws-cdk-automation added the pr-linter/exemption-requested The contributor has requested an exemption to the PR Linter feedback. label Jun 7, 2023
@jesterhazy
Copy link
Contributor Author

jesterhazy commented Jun 7, 2023

Clarification Request: which readme file would you expect to be updated for this?

@aws-cdk-automation aws-cdk-automation added pr/reviewer-clarification-requested The contributor has requested clarification on feedback, a failing build, or a failing PR Linter run pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. labels Jun 7, 2023
Copy link
Contributor

@corymhall corymhall left a comment

Choose a reason for hiding this comment

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

@jesterhazy thanks for taking the time to create this PR! Looking at the pasted issues on this I think we should try to solve this differently. I want to solve this 1 time, what is the absolute best we can do in regards to template size and how can we do it automatically.

We can either use the linked issue to discuss the potential solutions or you can create a new issue to discuss, I'll leave it up to you.

Copy link
Contributor

@corymhall corymhall left a comment

Choose a reason for hiding this comment

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

@jesterhazy actually after looking into this more I think you are on the right track. It looks like this is the best that we can do (for some reason I was thinking there was still something more we could do).

I only have 2 minor comments and then I'm good with this.

packages/aws-cdk-lib/core/lib/stack.ts Outdated Show resolved Hide resolved
packages/aws-cdk-lib/core/test/stack.test.ts Outdated Show resolved Hide resolved
@corymhall corymhall self-assigned this Jun 12, 2023
@corymhall corymhall removed the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Jun 12, 2023
@jesterhazy
Copy link
Contributor Author

@corymhall what needs to happen to move this forward?

Copy link
Contributor

@corymhall corymhall left a comment

Choose a reason for hiding this comment

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

Can you also add a simple integration test (or update an existing one) that sets the suppressTemplateIndentations: true. I just want to have a test that actually deploys a template without indentation.

packages/aws-cdk-lib/core/lib/stack.ts Outdated Show resolved Hide resolved
@corymhall corymhall added the pr-linter/exempt-integ-test The PR linter will not require integ test changes label Jun 14, 2023
@aws-cdk-automation aws-cdk-automation dismissed their stale review June 14, 2023 12:48

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

@mergify mergify bot dismissed corymhall’s stale review June 14, 2023 15:14

Pull request has been modified.

@jesterhazy
Copy link
Contributor Author

several of the tests in aws-lambda-nodejs/test/function.test.js are failing due to missing package lock files. I don't see this error when i run the unit tests locally, and this test doesn't seem at all related to this change. is something off in your CodeBuild environment?

@mergify
Copy link
Contributor

mergify bot commented Jun 15, 2023

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
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: bdd1a5c
  • 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 b705956 into aws:main Jun 15, 2023
@mergify
Copy link
Contributor

mergify bot commented Jun 15, 2023

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).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. p2 pr/reviewer-clarification-requested The contributor has requested clarification on feedback, a failing build, or a failing PR Linter run pr-linter/exempt-integ-test The PR linter will not require integ test changes pr-linter/exemption-requested The contributor has requested an exemption to the PR Linter feedback.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

(cdk cli): Create Smaller CloudFormation Templates
3 participants