CodeForPhilly / CodeForPhilly/balancer-main

Improve CI Pipelines: Linting, Formatting, Pre-commits, and Testing

Open
#458 0 comments 0 reactions 1 assignee Claimed by @sahilds1 View on GitHub
Documentation
Dominant language
TypeScript
Stars
21
Forks
19
PR merge metrics
No merged PRs in 30d

Description

The current CI workflows in `.github/workflows/frontend-ci.yml` and `.github/workflows/python-app.yml` are missing several critical quality checks.

### Proposed Improvements:

#### 1. Frontend (`frontend-ci.yml`)
- **Strict Checks:** Remove `continue-on-error: true` from `Lint` and `Build` steps so that PRs cannot be merged with failures.
- **Formatting:** Add a step to verify formatting using Prettier (e.g., `npx prettier --check .`).
- **Testing:** Add a step to run tests if any exist (e.g., `npm test`).
- **Dependency Cache:** Ensure Node.js cache is working correctly (already present but should be verified).

#### 2. Python Backend (`python-app.yml`)
- **Formatting:** Add Ruff formatting check (`ruff format --check`).
- **Testing:** Add a step to run Django tests (`python manage.py test`).
- **Branch Triggers:** Update branch triggers to include `develop` or the main branch (currently points to `listOfMed`).
- **Linting:** Improve Ruff linting configuration or ensure it's running with the desired rules.

#### 3. General Enhancements
- **Pre-commit Hooks:** Integrate `pre-commit` into CI to ensure all hooks pass before merging.
- **Consistency:** Align branch triggers across all CI workflows.

### Why is this needed?
To ensure code quality, consistency, and prevent regressions from being merged into the main branches.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.