feat(init-templates): app template comes with hint comments for 'env' #13696
Conversation
How the `env` parameter is supposed to be used is still confusing to a lot of users. Add uncommentable lines to the init templates showing and describing the 3 alternatives. Fixes #12321.
|
|
|
Not merging yet -- would like to get some agreement on verbiage before I apply the same to all templates. |
rix0rrr
added
pr-linter/exempt-readme
| @@ -4,4 +4,16 @@ import * as cdk from '@aws-cdk/core'; | |||
| import { %name.PascalCased%Stack } from '../lib/%name%-stack'; | |||
|
|
|||
| const app = new cdk.App(); | |||
| new %name.PascalCased%Stack(app, '%name.PascalCased%Stack'); | |||
| new %name.PascalCased%Stack(app, '%name.PascalCased%Stack', { | |||
| /* If you don't specify 'env', this stack will be environment-agnostic. | |||
There was a problem hiding this comment.
Other languages? v2 templates?
There was a problem hiding this comment.
Not merging yet -- would like to get some agreement on verbiage before I apply the same to all templates.
| new %name.PascalCased%Stack(app, '%name.PascalCased%Stack', { | ||
| /* If you don't specify 'env', this stack will be environment-agnostic. | ||
| * Account/Region-dependent features and context lookups will not work, | ||
| * but a single synthesized template can be deployed anywhere. */ |
There was a problem hiding this comment.
| * but a single synthesized template can be deployed anywhere. */ | |
| * but a single synthesized template can be deployed anywhere. | |
| * See https://docs.aws.amazon.com/cdk/latest/guide/stacks.html to | |
| * learn more about environment agnostic stacks. | |
| * See https://docs.aws.amazon.com/cdk/latest/guide/context.html to | |
| * learn more about runtime contexts. */ |
|
Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
|
Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
|
Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
…#13696) How the `env` parameter is supposed to be used is still confusing to a lot of users. Add uncommentable lines to the init templates showing and describing the 3 alternatives. Fixes #12321. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
…aws#13696) How the `env` parameter is supposed to be used is still confusing to a lot of users. Add uncommentable lines to the init templates showing and describing the 3 alternatives. Fixes aws#12321. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
How the
envparameter is supposed to be used is still confusing toa lot of users.
Add uncommentable lines to the init templates showing and describing
the 3 alternatives.
Fixes #12321.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license