docs(lambda): fromAsset exclude#26473
Conversation
|
The sample code must be compilable :) https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md#documentation Perhaps you have to change |
|
Thank you! I've never touched the rosetta file before so that helped! I fixed it and pushed it. |
|
|
||
| When using `lambda.Code.fromAsset(path)` an `exclude` property allows you to ignore particular files for assets based on simple glob patterns. | ||
|
|
||
| An `ignoreMode` property can be used to write based on the [.gitignore specification](https://git-scm.com/docs/gitignore) and the [.dockerignore specification](https://docs.docker.com/engine/reference/builder/#dockerignore-file). |
There was a problem hiding this comment.
What do you think about changing the wording to this:
When using lambda.Code.fromAsset(path) an exclude property allows you to ignore particular files for assets by providing patterns for file paths to exclude. Note that this has no effect on Assets bundled using the bundling property.
The ignoreMode property can be used with the exclude property to specify the file paths to ignore based on the .gitignore specification or the .dockerignore specification. The default behavior is to ignore file paths based on simple glob patterns.
There was a problem hiding this comment.
Thanks for your review! I think that's good. I will change.
|
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 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 main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
We discussed for the need to document `exclude` patterns using a negation in [the PR](aws#26365 (comment)). I also could not find documentation for the `exclude` property itself, so I added them. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
We discussed for the need to document
excludepatterns using a negation in the PR.I also could not find documentation for the
excludeproperty itself, so I added them.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license