Skip to content

Commit

Permalink
Document SAM
Browse files Browse the repository at this point in the history
  • Loading branch information
joehoyle committed Aug 9, 2023
1 parent 05bcae8 commit 4ebe817
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
# Contributing

## Release Process
## Building

You'll need to [install the AWS SAM CLI](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/install-sam-cli.html) as AWS SAM is used to build the ZIP and text the fixtures.

```
npm install
npm run build // Builds the function for use in SAM
npm run test // Invoke a function via SAM using a fixture from ./events/
```


1. Create and push a new tag following the convention `vx.x.x`
1. Build a new ZIP file by running `npm run build-node-modules && npm run build-zip`
1. Publish a new GitHub release, uploading `lambda.zip` as the built artifact to GitHub

0 comments on commit 4ebe817

Please sign in to comment.