Skip to content

Commit 508490c

Browse files
Consolidate contributing docs (#3606)
Have only one CONTRIBUTING.md to rule them all. --------- Co-authored-by: Ivana Kellyer <[email protected]>
1 parent c36f0db commit 508490c

File tree

2 files changed

+21
-21
lines changed

2 files changed

+21
-21
lines changed

CONTRIBUTING-aws-lambda.md

Lines changed: 0 additions & 21 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -172,3 +172,24 @@ sentry-sdk==2.4.0
172172
```
173173

174174
A major release `N` implies the previous release `N-1` will no longer receive updates. We generally do not backport bugfixes to older versions unless they are security relevant. However, feel free to ask for backports of specific commits on the bugtracker.
175+
176+
177+
## Contributing to Sentry AWS Lambda Layer
178+
179+
### Development environment
180+
181+
You need to have an AWS account and AWS CLI installed and setup.
182+
183+
We put together two helper functions that can help you with development:
184+
185+
- `./scripts/aws-deploy-local-layer.sh`
186+
187+
This script [scripts/aws-deploy-local-layer.sh](scripts/aws-deploy-local-layer.sh) will take the code you have checked out locally, create a Lambda layer out of it and deploy it to the `eu-central-1` region of your configured AWS account using `aws` CLI.
188+
189+
The Lambda layer will have the name `SentryPythonServerlessSDK-local-dev`
190+
191+
- `./scripts/aws-attach-layer-to-lambda-function.sh`
192+
193+
You can use this script [scripts/aws-attach-layer-to-lambda-function.sh](scripts/aws-attach-layer-to-lambda-function.sh) to attach the Lambda layer you just deployed (using the first script) onto one of your existing Lambda functions. You will have to give the name of the Lambda function to attach onto as an argument. (See the script for details.)
194+
195+
With these two helper scripts it should be easy to rapidly iterate your development on the Lambda layer.

0 commit comments

Comments
 (0)