Implement Code Coverage Badge Generation

[Savio629]

Description

Currently, our project lacks visibility into code coverage metrics on pull requests, making it challenging for contributors and reviewers to assess the impact of proposed changes on overall code quality. This issue aims to address this by implementing a CodeCov badge that generates code coverage metrics for pull requests, providing instant insights into the extent of test coverage for each change.

Objective

The primary objective of this issue is to integrate a CodeCov badge generation mechanism into our project's pull request workflow. By automatically generating and displaying code coverage metrics on pull requests, we aim to improve transparency and facilitate informed decision-making during code reviews.

Goals

• [x] Integrate CodeCov badge generation into the pull request workflow.
• [x] Configure the badge to dynamically display code coverage metrics for each pull request.
• [x] Ensure that code coverage metrics accurately reflect the test coverage for the proposed changes.

Complexity: Easy

Product Name

Stencil, Stencil-cli

Organisation Name

SamagraX

Complexity

Low

Domain

DevOps, Code Quality

Tech Skills Needed

GitHub Actions, CodeCov, Badge Generation

CodeCov Badge Ref -- https://github.com/nestjs/nest/blob/master/.github/workflows/codeql-analysis.yml https://docs.codecov.com/docs/status-badges

The coverage reports should be generated something like this: https://github.com/nestjs/nest/pull/13554#issuecomment-2101717097

This is a sub issue of https://github.com/SamagraX-Stencil/stencil/issues/46