Skip to content

Commit 8a9aa71

Browse files
committed
fix path in GHA workflow
1 parent eea1fd2 commit 8a9aa71

File tree

2 files changed

+30
-27
lines changed

2 files changed

+30
-27
lines changed

.github/workflows/dev.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ jobs:
6060
6161
- name: run integration test
6262
env:
63-
PYTHONPATH: functions/get_index:functions/get_restaurants:functions/search_restaurants
63+
PYTHONPATH: src/functions/get_index:src/functions/get_restaurants:src/functions/search_restaurants
6464
run: |
6565
pytest tests/integration \
6666
-s \

README.md

Lines changed: 29 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,10 @@ Status: Week 3 in progress
1111
* CDK deployment: [cdk/app.py](cdk/app.py)
1212

1313
* REST API:
14-
* lambda functions with lambda-power-tools handling and pydantic data models, exposed via a REST API Gateway
14+
* implementation:
15+
* lambda functions exposed via a REST API Gateway
16+
* handled by lambda-power-tools handling
17+
* pydantic data models
1518
* endpoints:
1619
* `/restaurants`:
1720
* internal API listing all restaurants from DynamoDB
@@ -38,9 +41,33 @@ source .venv-box/bin/activate
3841
pip install -r cdk/requirements.txt
3942
```
4043

44+
# Shared SSM parameters
45+
46+
In this project, SSM is used for the configuration shared across different deployments, following the convention:
47+
48+
```
49+
/{SERVICE_NAME}/shared_context/{MATURITY_LEVEL}/..."
50+
```
51+
52+
where:
53+
54+
* `SERVICE_NAME` is the name of the service, e.g. `production-ready-serverless`
55+
* `MATURITY_LEVEL` is linked to the release life cycle, e.g. `dev`, `test`, `acc`, `prod`
56+
57+
Those parameters are expected to be created before the deployment and their value is shared across all deployments
58+
having the same maturity level. This allows to share contextual information, like the URL of 3rd API,...
59+
60+
For dynamic configuration that should not be shared across deployments, e.g. feature flags, we could use a
61+
convention similar to the following instead:
62+
63+
```
64+
# (not currently implemented in this demo project)
65+
/{SERVICE_NAME}/{FEATURE_NAME}/..."
66+
```
67+
4168
# How to use
4269

43-
The `STAGE_NAME` env variable is used to prefix the stack and API names.
70+
The `FEATURE_NAME` env variable is used to prefix the stack and API names.
4471

4572
Build and deploy:
4673

@@ -115,27 +142,3 @@ FEATURE_NAME=feature-foo \
115142
--gherkin-terminal-reporter -v
116143
```
117144

118-
# Shared SSM parameters
119-
120-
In this project, SSM is used for the configuration shared across different deployments, following the convention:
121-
122-
```
123-
/{SERVICE_NAME}/shared_context/{MATURITY_LEVEL}/..."
124-
```
125-
126-
where:
127-
128-
* `SERVICE_NAME` is the name of the service, e.g. `production-ready-serverless`
129-
* `MATURITY_LEVEL` is linked to the release life cycle, e.g. `dev`, `test`, `acc`, `prod`
130-
131-
Those parameters are expected to be created before the deployment.
132-
133-
This allows to share contextual information, like the URL of 3rd API, across all environments of a given maturity level.
134-
135-
For dynamic configuration that should not be shared across deployments, e.g. feature flags,
136-
we could use a convention similar to the following instead:
137-
138-
```
139-
# (not currently implemented in this demo project)
140-
/{SERVICE_NAME}/{FEATURE_NAME}/..."
141-
```

0 commit comments

Comments
 (0)