Skip to content

ci: Add GitHub Actions CI/CD workflows for automated testing and linting #24

@NobleCoder69

Description

@NobleCoder69

Problem Statement

Currently, there's no automated testing or code quality checks on every pull request. This means:

  • Broken code can be merged
  • Code quality issues aren't caught automatically
  • No consistency enforcement
  • Manual review burden is high

Objective

Add GitHub Actions workflows to automatically:

  • Run pre-commit hooks (lint, format, type check)
  • Run automated tests
  • Provide feedback on PRs
  • Auto-fix formatting issues

Acceptance Criteria

  1. Create .github/workflows/lint.yml with:

    • Run pre-commit hooks on every PR
    • Report failures
    • Suggest fixes
  2. Create .github/workflows/tests.yml with:

    • Run pytest on every PR
    • Report test results
    • Check coverage (if tests exist)
  3. Create .github/workflows/format.yml with:

    • Auto-fix formatting issues
    • Commit fixes back to PR
    • Comment on PR with changes
  4. Document workflows in .github/workflows/README.md

Success Metrics

✅ Pre-commit hooks run automatically on every PR
✅ Test results visible in PR checks
✅ Auto-fixes committed to PR branch
✅ Clear feedback on code quality
✅ No manual intervention needed

Notes

  • Workflows run on every push and PR
  • Uses pre-commit framework (already configured)
  • Uses pytest for tests (if tests added later)
  • Auto-fix requires write permissions

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions