Skip to content

Commit 5c05c14

Browse files
ran-isenbergRan Isenberg
andauthored
docs: update docs with latest blogs and features, update deps (#802)
Co-authored-by: Ran Isenberg <ran.isenberg@ranthebuilder.cloud>
1 parent 6985a70 commit 5c05c14

File tree

8 files changed

+180
-162
lines changed

8 files changed

+180
-162
lines changed

.github/workflows/main-serverless-service.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ jobs:
7171
env:
7272
ENVIRONMENT: staging # Custom environment variable
7373
- name: Codecov
74-
uses: codecov/codecov-action@f30e4959ba63075080d4f7f90cacc18d9f3fafd7 # v4.0.0
74+
uses: codecov/codecov-action@e0b68c6749509c5f83f984dd99a76a1c1a231044 # v4.0.1
7575
with:
7676
token: ${{ secrets.CODECOV_TOKEN }}
7777
files: ./coverage.xml

.github/workflows/pr-serverless-service.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ jobs:
9999
- name: Code coverage tests
100100
run: make coverage-tests
101101
- name: Codecov
102-
uses: codecov/codecov-action@f30e4959ba63075080d4f7f90cacc18d9f3fafd7 # v4.0.0
102+
uses: codecov/codecov-action@e0b68c6749509c5f83f984dd99a76a1c1a231044 # v4.0.1
103103
with:
104104
token: ${{ secrets.CODECOV_TOKEN }}
105105
files: ./coverage.xml

.pre-commit-config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ repos:
2626
exclude: "^(?!helpers/)"
2727
- repo: https://github.com/astral-sh/ruff-pre-commit
2828
# Ruff version.
29-
rev: v0.2.0
29+
rev: v0.2.2
3030
hooks:
3131
# Run the Ruff linter.
3232
- id: ruff

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,12 @@ Starting a Serverless service can be overwhelming. You need to figure out many q
6666

6767
This project aims to reduce cognitive load and answer these questions for you by providing a skeleton Python Serverless service template that implements best practices for AWS Lambda, Serverless CI/CD, and AWS CDK in one template project.
6868

69+
## Concepts
70+
71+
I spoke at AWS re:invent 2023 with Heitor Lessa, Chief Architect of Powertools for AWS Lambda about the concepts I implemented in this project.
72+
73+
[![Watch the video](https://img.youtube.com/vi/52W3Qyg242Y/maxresdefault.jpg)](https://www.youtube.com/watch?v=52W3Qyg242Y)
74+
6975
### Serverless Service - The Order service
7076

7177
- This project provides a working orders service where customers can create orders of items.
@@ -93,8 +99,9 @@ This project aims to reduce cognitive load and answer these questions for you by
9399
- REST API protected by WAF with four AWS managed rules in production deployment
94100
- CloudWatch dashboards - High level and low level including CloudWatch alarms
95101
- Unit, infrastructure, security, integration and end to end tests.
96-
- Automatically generated OpenAPI endpoint: /swagger with Pydnatic schemas for both requests and responses
102+
- Automatically generated OpenAPI endpoint: /swagger with Pydantic schemas for both requests and responses
97103
- CI swagger protection - fails the PR if your swagger JSON file (stored at docs/swagger/openapi.json) is out of date
104+
- Automated protection against API breaking changes
98105

99106

100107
## CDK Deployment
@@ -121,6 +128,7 @@ The utilities cover multiple aspect of a production-ready service, including:
121128
- [CDK Best practices](https://github.com/ran-isenberg/aws-lambda-handler-cookbook)
122129
- [Serverless Monitoring](https://www.ranthebuilder.cloud/post/how-to-effortlessly-monitor-serverless-applications-with-cloudwatch-part-one)
123130
- [API Idempotency](https://www.ranthebuilder.cloud/post/serverless-api-idempotency-with-aws-lambda-powertools-and-cdk)
131+
- [Serverless OpenAPI Documentation with AWS Powertools](https://www.ranthebuilder.cloud/post/serverless-open-api-documentation-with-aws-powertools)
124132

125133
## Getting started
126134
Head over to the complete project documentation pages at GitHub pages at [https://ran-isenberg.github.io/aws-lambda-handler-cookbook](https://ran-isenberg.github.io/aws-lambda-handler-cookbook/)

docs/index.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,12 @@ This project aims to reduce cognitive load and answer these questions for you by
3131

3232
<img alt="alt_text" src="./media/monitoring_design.png" />
3333

34+
## Concepts
35+
36+
I spoke at AWS re:invent 2023 with Heitor Lessa, Chief Architect of Powertools for AWS Lambda about the concepts I implemented in this project.
37+
38+
<iframe width="560" height="315" src="https://www.youtube.com/embed/52W3Qyg242Y" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
39+
3440
### **Features**
3541

3642
- Python Serverless service with a recommended file structure.
@@ -46,7 +52,8 @@ This project aims to reduce cognitive load and answer these questions for you by
4652
- Idempotent API
4753
- REST API protected by WAF with four AWS managed rules in production deployment
4854
- Unit, infrastructure, security, integration and E2E tests.
49-
- Automatically generated OpenAPI endpoint: /swagger with Pydnatic schemas for both requests and responses
55+
- Automatically generated OpenAPI endpoint: /swagger with Pydantic schemas for both requests and responses
56+
- Automated protection against API breaking changes
5057

5158
The GitHub template project can be found at [https://github.com/ran-isenberg/aws-lambda-handler-cookbook](https://github.com/ran-isenberg/aws-lambda-handler-cookbook){:target="_blank" rel="noopener"}.
5259

@@ -67,6 +74,7 @@ The utilities cover multiple aspects of a production-ready service, including:
6774
- [**Serverless Monitoring**](https://www.ranthebuilder.cloud/post/how-to-effortlessly-monitor-serverless-applications-with-cloudwatch-part-one)
6875
- [**API Idempotency**](https://www.ranthebuilder.cloud/post/serverless-api-idempotency-with-aws-lambda-powertools-and-cdk){:target="_blank" rel="noopener"}
6976
- [**Learn How to Write AWS Lambda Functions with Three Architecture Layers**](https://www.ranthebuilder.cloud/post/learn-how-to-write-aws-lambda-functions-with-architecture-layers){:target="_blank" rel="noopener"}
77+
- [**Serverless OpenAPI Documentation with AWS Powertools**](https://www.ranthebuilder.cloud/post/serverless-open-api-documentation-with-aws-powertools){:target="_blank" rel="noopener"}
7078

7179
While the code examples are written in Python, the principles are valid to any supported AWS Lambda handler programming language.
7280

package-lock.json

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
22
"dependencies": {
3-
"aws-cdk": "2.126.0"
3+
"aws-cdk": "2.128.0"
44
}
55
}

0 commit comments

Comments
 (0)