Skip to content

Commit 3481059

Browse files
committed
Update README.md
1 parent 94f9231 commit 3481059

File tree

2 files changed

+13
-10
lines changed

2 files changed

+13
-10
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
# Contributing
22

3-
## Publish a new release
4-
5-
- Bump [`package.json`](./package.json) version (ie.: 1.0.0)
6-
- Create a new release (ie.: v1.0.0)
7-
- A GitHub workflow will automatically run, build and upload the new code to AWS Lambda.
8-
93
## Testing
104

115
```bash
126
yarn install
137
yarn test
148
```
159

10+
## Publish a new release
11+
12+
- Bump [`package.json`](./package.json) version (ie.: 1.0.0)
13+
- Create a new release (ie.: v1.0.0)
14+
- A GitHub workflow will automatically run, build and upload the new code to AWS Lambda.
15+
1616
## Note about `aws-sdk`
1717

1818
`aws-sdk` is placed as a devDependency in the projet in order to build smaller zip file for the distribution.

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,15 @@ See [Resource: aws_lambda_function](https://registry.terraform.io/providers/hash
2121
In order to be able to receive http requests to the lambda, you will need to hook it up with an AWS API Gateway.
2222
You can do so by following this guide: [Serverless Applications with AWS Lambda and API Gateway](https://learn.hashicorp.com/tutorials/terraform/lambda-api-gateway).
2323

24+
After applying the terraform plan, a dummy lambda will be available in the [AWS Lambda Console](https://console.aws.amazon.com/lambda/).
25+
26+
## Deploying a new version of the lambda
27+
28+
- Make sure you have all the required [GitHub Actions secrets](https://docs.github.com/en/free-pro-team@latest/actions/reference/encrypted-secrets) for [`.github/workflows/release.yml`](.github/workflows/release.yml) to work.
29+
- Follow [CONTRIBUTING.md / Publish a new release](./CONTRIBUTING.md#publish-a-new-release) for deploying a new release.
30+
2431
---
2532

2633
Your AWS lambda should now be available at https://console.aws.amazon.com/lambda/.
2734

2835
Logs from the lambda will be available in AWS CloudWatch `/aws/lambda/${yourLambdaName}` log group.
29-
30-
## Release a new version of the Terraform module
31-
32-
See the [CONTRIBUTING.md](./CONTRIBUTING.md) file for more info.

0 commit comments

Comments
 (0)