From e2d0f00c71d242d1f0d98c2300cc3f773a74a93c Mon Sep 17 00:00:00 2001 From: alexau Date: Sun, 3 Dec 2023 23:28:04 +0800 Subject: [PATCH] Updated the table of contents --- .github/workflows/test.yml | 2 +- README.md | 22 ++++++++++++++++++++++ 2 files changed, 23 insertions(+), 1 deletion(-) diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 06c8fee..c24bdf4 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -1,7 +1,7 @@ name: Producer Consumer CI Test on: push: - branches: ["dev"] + branches: ["main", "dev"] workflow_dispatch: jobs: load-dotenv: diff --git a/README.md b/README.md index f31345f..c2ed4e3 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,25 @@ ![Build Status](https://github.com/github/docs/actions/workflows/test.yml/badge.svg) ![Code Coverage](./coverage.svg) +## Table of contents + +* [Producer Consumer CSV](#producer-consumer-csv) + * [Description](#description) + * [Architecture](#architecture) + * [Requirements](#requirements) + * [Database Schema](#database-schema) + * [records](#records) + * [Database Indexes](#database-indexes) + * [Queue](#queue) + * [Test Data](#test-data) + * [Installation](#installation) + * [Usage](#usage) + * [Postgres in Docker](#postgres-in-docker) + * [Running the application](#running-the-application) + * [End to end test](#end-to-end-test) + * [Unit tests](#unit-tests) + * [Code coverage report](#code-coverage-report) + ## Description This is a simple producer consumer application that reads a csv file and writes the data to a database. The application is written in Python. @@ -213,3 +232,6 @@ $ make test ``` The unit test will run the both the producer and consumer unit tests. The coverage report will be generated in the `.coverage` file. + +### Code coverage report +You can generate the code coverage report by visiting the following link: https://alex-au-922.github.io/producer_consumer_csv/