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.

Sign up for GitHub

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

Jump to bottom

refactor: make "toCloudFormation" internal #2047

Merged
merged 1 commit into from
Mar 19, 2019
Merged

refactor: make "toCloudFormation" internal #2047

merged 1 commit into from
Mar 19, 2019

Conversation

eladb
Copy link
Contributor

@eladb eladb commented Mar 19, 2019 •
edited
Loading

The method toCloudFormation is not supposed to be directly called by users. Mark it as @internal and rename to _toCloudFormation.

Fixes #2044
Related #2016

Pull Request Checklist

  • Testing
    • Unit test added (prefer not to modify an existing test, otherwise, it's probably a breaking change)
    • CLI change?: coordinate update of integration tests with team
    • cdk-init template change?: coordinated update of integration tests with team
  • Docs
    • jsdocs: All public APIs documented
    • README: README and/or documentation topic updated
  • Title and Description
    • Change type: title prefixed with fix, feat will appear in changelog
    • Title: use lower-case and doesn't end with a period
    • Breaking?: last paragraph: "BREAKING CHANGE: <describe what changed + link for details>"
    • Issues: Indicate issues fixed via: "Fixes #xxx" or "Closes #xxx"
  • Sensitive Modules (requires 2 PR approvers)
    • IAM Policy Document (in @aws-cdk/aws-iam)
    • EC2 Security Groups and ACLs (in @aws-cdk/aws-ec2)
    • Grant APIs (only if not based on official documentation with a reference)

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

refactor: name "toCloudFormation" internal (renamed to "_toCloudForma…
45cfdab 
…tion")

The method `toCloudFormation` is not supposed to be directly called by
users. Mark it as `@internal` and rename to `_toCloudFormation`.

Fixes #2044
Related #2016
@eladb eladb requested review from RomainMuller, skinny85 and a team as code owners March 19, 2019 07:22
RomainMuller
RomainMuller approved these changes Mar 19, 2019
View reviewed changes
packages/@aws-cdk/assert/lib/expect.ts
@@ -20,7 +20,7 @@ export function expect(stack: api.SynthesizedStack | cdk.Stack, skipValidation =

sstack = {
name: stack.name,
template: stack.toCloudFormation(),
template: stack._toCloudFormation(),
Copy link
Contributor

Choose a reason for hiding this comment

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

Why we renaming to _toCloudFormation given that we have aws/jsii#390 in the pipes? Can we not just @internal the method?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think in the CDK I'd like to standardize (awslint) that internal members are also prefixed with an underscore to make it clear to maintainers that they are internal.

@eladb eladb merged commit 515868b into master Mar 19, 2019
rix0rrr pushed a commit to alex-berger/aws-cdk that referenced this pull request Mar 19, 2019
@rix0rrr
refactor: name "toCloudFormation" internal (renamed to "_toCloudForma…
5aa4fc7 
…tion") (aws#2047)

The method `toCloudFormation` is not supposed to be directly called by
users. Mark it as `@internal` and rename to `_toCloudFormation`.

Fixes aws#2044
Related aws#2016

BREAKING CHANGE: “toCloudFormation” is now internal and should not be called directly. Instead use “app.synthesizeStack”
@rix0rrr rix0rrr deleted the benisrae/hide-to-cloudformation branch April 23, 2019 07:12
@NGL321 NGL321 added the contribution/core This is a PR that came from AWS. label Sep 23, 2019
@mergify
Copy link
Contributor

mergify bot commented Sep 23, 2019

Thanks so much for taking the time to contribute to the AWS CDK ❤️

We will shortly assign someone to review this pull request and help get it
merged. In the meantime, please take a minute to make sure you follow this
checklist:

  • PR title type(scope): text
    • type: fix, feat, refactor go into CHANGELOG, chore is hidden
    • scope: name of module without aws- or cdk- prefix or postfix (e.g. s3 instead of aws-s3-deployment)
    • text: use all lower-case, do not end with a period, do not include issue refs
  • PR Description
    • Rationale: describe rationale of change and approach taken
    • Issues: indicate issues fixed via: fixes #xxx or closes #xxx
    • Breaking?: last paragraph: BREAKING CHANGE: <describe what changed + link for details>
  • Testing
    • Unit test added. Prefer to add a new test rather than modify existing tests
    • CLI or init templates change? Re-run/add CLI integration tests
  • Documentation
    • README: update module README to describe new features
    • API docs: public APIs must be documented. Copy from official AWS docs when possible
    • Design: for significant features, follow design process

This was referenced Dec 12, 2019
Closed
Open
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@RomainMuller RomainMuller RomainMuller approved these changes

@rix0rrr rix0rrr rix0rrr approved these changes

@skinny85 skinny85 Awaiting requested review from skinny85

Assignees
No one assigned
Labels
contribution/core This is a PR that came from AWS.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Make Stack.toCloudFormation @internal (and prefix with underscore)
4 participants
@eladb @RomainMuller @rix0rrr @NGL321