Skip to content

Commit 74d4abe

Browse files
committed
Add examples contributing
1 parent 9b732a3 commit 74d4abe

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

CONTRIBUTING.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,27 @@ You can build and start a local docs website by running these two commands.
5757
- `npm run docs-buildDockerImage` OR `docker build -t squidfunk/mkdocs-material ./docs/`
5858
- `npm run docs-runLocalDocker` OR `docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material`
5959

60+
### Examples
61+
62+
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.
63+
64+
To test your updates with this examples you just have to:
65+
66+
1. Build your local version of *aws-lambda-powertools-typescript* npm packages with `npm run lerna-package`
67+
1. Update their references in examples
68+
```
69+
cd examples/cdk
70+
npm install ../../packages/**/dist/aws-lambda-powertools-*
71+
```
72+
1. Run cdk tests
73+
```
74+
npm run test
75+
```
76+
1. Deploy
77+
```
78+
npm run cdk deploy
79+
```
80+
6081
### Conventions
6182
6283
Category | Convention

0 commit comments

Comments
 (0)