Skip to content

Add ML worker CI and PR template#84

Merged
SahilKumar75 merged 1 commit into
mainfrom
codex/ml-worker-ci-template
May 10, 2026
Merged

Add ML worker CI and PR template#84
SahilKumar75 merged 1 commit into
mainfrom
codex/ml-worker-ci-template

Conversation

@SahilKumar75
Copy link
Copy Markdown
Owner

@SahilKumar75 SahilKumar75 commented May 10, 2026

Summary

  • Adds a dedicated ML worker GitHub Actions workflow.
  • Replaces the default PR template with concise review and verification prompts.
  • Updates repository and worker docs for the current pytest workflow.

Linked Issue

Closes #79
Closes #83

What Changed

  • Added .github/workflows/ml-worker.yml for Python 3.11 and 3.12 worker tests.
  • Updated .github/pull_request_template.md to require issue links, verification, review notes, and risks.
  • Aligned README and contributing guidance with the worker test command.

Verification

  • cd app && npx tsc --noEmit
  • cd backend && mvn test
  • cd ml-worker && pytest attempted; collection currently stops on the pre-existing OperationMetrics import mismatch in tests/test_metrics.py.
  • git diff --check

Review Notes

  • Areas to check: workflow trigger paths, Python matrix, PR template wording.
  • Data, API, or ML worker contract changes: none.

Risks And Follow-Up

Summary by CodeRabbit

  • Documentation

    • Updated Python version requirement to 3.11+ for ML Worker.
    • Revised ML Worker test instructions to use pytest for testing.
    • Updated README with current testing procedures and CI badge.
  • Chores

    • Added automated ML Worker testing workflow.
    • Updated pull request template and contribution guidelines for clearer submission requirements.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 10, 2026

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Walkthrough

This PR introduces a new GitHub Actions workflow for the ML worker package, redesigns the pull request template for structured hygiene, and updates documentation to align with the new testing and verification expectations across the repository.

Changes

ML Worker Testing CI and PR Template Standardization

Layer / File(s) Summary
ML Worker CI Workflow
.github/workflows/ml-worker.yml
New workflow triggers on pull_request, push to main, and manual dispatch for ml-worker/** changes. Runs pytest across Python 3.11 and 3.12 with pip caching and editable dev-mode installation.
Pull Request Template Redesign
.github/pull_request_template.md
Restructured template with explicit Summary, Linked Issue ("Closes #"), What Changed, Verification checklist (app/backend/ml-worker commands), Review Notes, and Risks And Follow-Up sections.
Contribution and Review Guidance
CONTRIBUTING.md
Added requirement to use .github/pull_request_template.md with summary, linked issue, and actual verification commands. Extended review checklist to require ML worker changes document pytest results or state reason tests were not run.
README Documentation Alignment
README.md, ml-worker/README.md
Updated main README to specify Python 3.11+, changed test command to pytest, and documented GitHub Actions test matrix. Updated ml-worker README with ml-worker-specific CI badge, rewrote Features section, changed test command from make test to pytest, and documented the Python 3.11–3.12 test matrix.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

  • SahilKumar75/sentri#53: Updates to .github/pull_request_template.md and CONTRIBUTING.md directly overlap with prior PR template and contribution material changes.

Poem

🐰 A workflow takes shape, clear and precise,
Templates tighten, tests now suffice,
Python 3.11 through 3.12 we race,
ML worker CI claims its rightful place!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Add ML worker CI and PR template' clearly and concisely summarizes the main changes: adding a GitHub Actions workflow for ML worker testing and updating the PR template.
Description check ✅ Passed The PR description covers all key sections with appropriate detail: Summary, Linked Issue, What Changed, Verification, Review Notes, and Risks And Follow-Up aligned with repository expectations.
Linked Issues check ✅ Passed All coding objectives from issues #79 and #83 are met: ML worker workflow added for Python 3.11/3.12 with pip caching, PR template updated with required sections, and documentation aligned with pytest commands.
Out of Scope Changes check ✅ Passed All changes are directly related to the linked issues: workflow creation, template updates, and documentation alignment for ML worker CI and PR guidance; no extraneous modifications detected.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/ml-worker-ci-template

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Owner Author

@SahilKumar75 SahilKumar75 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review pass 1: The workflow is scoped to worker paths and manual dispatch, which keeps unrelated app/backend changes out of this test job. Before merge, confirm the workflow file lands before relying on the badge in the worker README.

Copy link
Copy Markdown
Owner Author

@SahilKumar75 SahilKumar75 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review pass 2: The default PR template is short enough to fill in consistently. The verification section should stay command-based; avoid adding broad checklist items that reviewers cannot verify from the diff.

@SahilKumar75 SahilKumar75 merged commit a2c57df into main May 10, 2026
0 of 3 checks passed
@SahilKumar75 SahilKumar75 deleted the codex/ml-worker-ci-template branch May 10, 2026 08:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Tighten default pull request template Add ML worker CI for pull requests

1 participant