Merge pull request #15 from awslabs/uploadAssetWorkflow

fix: updating ci.yml

.github/workflows/ci.yml

@@ -19,13 +19,12 @@
           python-version: 3.9
 
       - name: Install Poetry Action
-        working-directory: backend
         uses: snok/install-poetry@v1
         with:
           version: 1.1.13
           virtualenvs-create: true
           virtualenvs-in-project: true
-          virtualenvs-path: .venv
+          virtualenvs-path: backend/.venv
           installer-parallel: true
 
       - name: run checks

backend/README.rst

@@ -4,7 +4,6 @@ Make sure you have poetry installed and your local python version is using the p
 
 ### How to build this package
 The Dockerfile should do everything you would need. If you included new dependencies make sure you export them into the requirements file.
-Sometimes creating the container image fails in presence of the poetry.lock file so please remove the poetry.lock file once your dependecies have been exported.
 
 More Details:
 https://github.com/aws/aws-cdk/issues/14201
@@ -18,3 +17,19 @@ https://github.com/aws/aws-cdk/issues/14201
 ### Export poetry dependecies to requirements.txt
 `poetry export -o requirements.txt --without-hashes`
 
+
+### Running Tests
+`make all` should trigger all the code checks we have included so far
+We use
+1. flake8 for linting
+2. mypy for type checks
+3. pytest for running Tests
+4. coverage to run code coverage
+
+### Why does my PR fail in actions
+
+Likely because of some failure while `make all`.
+
+Try running github actions locally with [act](https://github.com/nektos/act/)
+
+`act` should pickup the current ci.yml and run it locally inside a docker container