docs: note that Apps outdir property should not be used
#16670
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
If this property is passed it has to agree with the CLI's `--output` flag. If this property is not passed, it will default to the CLI's `--output` flag. In either case, it's better to just use `--output` and not pass this property at all; the property only has value inside tests. Fixes #3717.
|
|
RomainMuller
force-pushed
the
master
branch
from
924c117 to
ebfd5f2
Compare
eladb
reviewed
Sep 29, 2021
| deployment role | ||
| Default: '' | ||
| Type: CommaDelimitedList | ||
| PermissionsBoundaryArns: |
packages/@aws-cdk/core/lib/app.ts
Outdated
| @@ -104,6 +111,10 @@ export class App extends Stage { | |||
| outdir: props.outdir ?? process.env[cxapi.OUTDIR_ENV], | |||
| }); | |||
|
|
|||
| if (process.env[cxapi.OUTDIR_ENV] && props.outdir) { | |||
There was a problem hiding this comment.
Would be nice to add a unit test for this if possible
rix0rrr
changed the title
Apps outdir property should not be usedApps outdir property should not be used
njlynch
approved these changes
Oct 27, 2021
|
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). |
TikiTDO
pushed a commit
to TikiTDO/aws-cdk
that referenced
this pull request
Feb 21, 2022
If this property is passed it has to agree with the CLI's `--output` flag. If this property is not passed, it will default to the CLI's `--output` flag. In either case, it's better to just use `--output` and not pass this property at all; the property only has value inside tests. I tried to add validation (by using `Annotations.of(app).addWarning()` but they are useless anyway: in the CX protocol, metadata can only be attached to `StackArtifacts`, so metadata attached to the `App` will not be rendered. Adding a full framework feature to move metadata to a different place feels like too much risk and work for this small note, so turned it into a documentation fix. Fixes aws#3717. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
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.
If this property is passed it has to agree with the CLI's
--outputflag.If this property is not passed, it will default to the CLI's
--outputflag.
In either case, it's better to just use
--outputand not pass thisproperty at all; the property only has value inside tests.
I tried to add validation (by using
Annotations.of(app).addWarning()but they areuseless anyway: in the CX protocol, metadata can only be attached to
StackArtifacts,so metadata attached to the
Appwill not be rendered.Adding a full framework feature to move metadata to a different place feels like too much
risk and work for this small note, so turned it into a documentation fix.
Fixes #3717.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license