Skip to content

GIF : CI/CD pipeline for warning check #3554

@JeevaRamu0104

Description

@JeevaRamu0104

Summary

Add a warning check step in the CI/CD pipeline.

Type

Issue

Context

Currently, our project does not have a step in the CI/CD pipeline to check for compiler warnings. This can cause unnoticed warnings to accumulate, leading to potential issues in production code.

By integrating a warning check step into the pipeline, we can automatically detect compiler warnings during pull requests and enforce a clean, warning-free codebase. The command to be executed for this check is:

npm run re:build

Expected:

  • The warning-check CI job should pass when there are no warnings.
  • The warning-check CI job should fail if any warnings are detected.

Acceptance Criteria

  • A new GitHub Actions workflow (.github/workflows/warning-check.yml) is added to run the warning check.
  • The workflow runs on every pull request and push to main.
  • The pipeline executes the command npm run re:build.
  • The pipeline fails if any warnings are detected, and passes when no warnings are found.
  • Documentation is updated with instructions on running the warning check locally (npm run re:build).

Relavant Files

Resources

Existing workflow in the hyperswitch
https://github.com/juspay/hyperswitch/blob/main/.github/workflows/CI-pr.yml

Mentor contact

@JeevaRamu0104

Helpful Docs

Pre-flight

  • I read the Contributing Guide and setup
  • I searched existing issues and PRs

Metadata

Metadata

Assignees

Labels

Good First IssueIssues which are beginner friendly and will give a starting understanding about the repohacktoberfest

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions