adding cd workflow, updating docker compose, main readme and dev dockerfile

Author: rafaelgreca

.github/workflows/docker.yaml

@@ -0,0 +1,40 @@
+name: ci
+
+on:
+  push:
+
+jobs:
+  docker:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+      -
+        name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+      -
+        name: Login to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+      -
+        name: Build and push Docker dev image
+        uses: docker/build-push-action@v6
+        with:
+          push: true
+          context: "{{defaultContext}}:notebooks"
+          file: Dockerfile.dev
+          tags: ${{ secrets.DOCKERHUB_USERNAME }}/e2e-dev:latest
+          cache-from: type=registry,ref=${{ secrets.DOCKERHUB_USERNAME }}/e2e-dev:latest
+          cache-to: type=inline
+      -
+        name: Build and push Docker prod image
+        uses: docker/build-push-action@v6
+        with:
+          push: true
+          file: Dockerfile
+          tags: ${{ secrets.DOCKERHUB_USERNAME }}/e2e-prod:latest
+          cache-from: type=registry,ref=${{ secrets.DOCKERHUB_USERNAME }}/e2e-prod:latest
+          cache-to: type=inline

.github/workflows/test.yaml

@@ -18,4 +18,4 @@ jobs:
 
     - name: Testing with Pytest
       run: |
-        pytest --cov-report html:./reports/cov_html --cov=src/ tests/
+        pytest --cov-report html:../reports/cov_html --cov=. ../tests/

README.md

@@ -248,13 +248,15 @@ P.S.: if you are interested in modifying the code as you desire, it's better to
 
 4. (OPTIONAL) Use the script included within the **data** folder to download both datasets (one for testing and the other for training and verifying the model). You can run that from your study environment as well.
 
-5. Use the following command to install the pre-commit package manager:
+5. In order to save both Dockerfiles (for the development and production environments) in Docker Hub, you need to set up your `DOCKERHUB_USERNAME` and `DOCKERHUB_TOKEN` secrets in the repository's settings (`Settings > Secrets and Variables > Actions`).
+
+6. Use the following command to install the pre-commit package manager:
 
 ```bash
 pip install pre-commit
 ```
 
-6. Activate pre-commit using the following command:
+7. Activate pre-commit using the following command:
 
 ```bash
 pre-commit install
@@ -309,6 +311,10 @@ docker compose up -d --no-deps --build test
 
 12. It should take a few seconds for the tests to complete. After that, you can run `docker logs <TEST_CONTAINER_ID>` to see the overall results or view the test coverage by looking at the `cov_html` folder inside the `reports` folder.
 
+13. The docker's GitHub action/workflow will save both Dockerfiles (one for the develop/research environment and the other for the production environmet) images in your DockerHub's profile, as illustrated in the figure below.
+
+![Docker Hub](images/dockerhub.png)
+
 DISCLAIMER: Just the workflow in the research environment was tested with AWS because of financial constraints. Docker Compose should be used to run everything locally in order to fully experience both research and production workflows.
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
@@ -317,7 +323,7 @@ DISCLAIMER: Just the workflow in the research environment was tested with AWS be
 ## Roadmap
 
 - [ ] Add end-to-end test cases.
-- [ ] Add a Continuous Delivery (CD) GitHub Action.
+- [X] Add a Continuous Delivery (CD) GitHub Action.
 - [ ] Add a integration test case to assure that the model's performance showed in MLflow is the same when evaluating the model on the same data, but using the API's code.
 - [ ] Integrate uvicorn to FastAPI.
 - [ ] Fix the test GitHub's workflow (it's not finishing because needs connection with FastAPI and MLflow to validate some tests).

docker-compose.yaml

@@ -4,8 +4,8 @@ services:
     image: e2e-dev:latest
 
     build:
-      context: ./notebooks/
-      dockerfile: ./Dockerfile.dev
+      context: .
+      dockerfile: ./notebooks/Dockerfile.dev
 
     depends_on:
       - mlflow

images/dockerhub.png

@@ -8,7 +8,7 @@ RUN apt-get update && apt-get install -y python3.10 python3.10-venv python3.10-d
 RUN mkdir -p /e2e-project/notebooks
 
 # copying all the files within this folder to the newly created folder
-COPY . /e2e-project/notebooks
+COPY /notebooks /e2e-project/notebooks/
 
 # setting the curreting directory to be the folder containing the notebooks
 WORKDIR /e2e-project