Skip to content

Commit a7a91ad

Browse files
committed
Add examples contributing
1 parent 4cdaaea commit a7a91ad

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

CONTRIBUTING.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,29 @@ You can run the end-to-end tests automatically on your forked project by followi
147147
4. In the run-e2e-tests workflow page, select "Run workflow" and run it on the desired branch.
148148

149149
> :warning: **Don't automatically run end-to-end tests on branch push or PRs**. A malicious attacker can submit a pull request to attack your AWS account. Ideally, use a blank account without any important workload/data, and limit `AWS_ROLE_ARN_TO_ASSUME` permission to least minimum privilege.
150+
151+
152+
### Examples
153+
154+
As part of the repo you will find an examples folder at the root. This folder contains examples (written with CDK for now) of deployable lambdas using powertools lib.
155+
156+
To test your updates with this examples you just have to:
157+
158+
1. Build your local version of *aws-lambda-powertools-typescript* npm packages with `npm run lerna-package`
159+
1. Update their references in examples
160+
```
161+
cd examples/cdk
162+
npm install ../../packages/**/dist/aws-lambda-powertools-*
163+
```
164+
1. Run cdk tests
165+
```
166+
npm run test
167+
```
168+
1. Deploy
169+
```
170+
npm run cdk deploy
171+
```
172+
150173
### Conventions
151174
152175
Category | Convention

0 commit comments

Comments
 (0)