Skip to content

Improve CI and docs#184

Open
soumendrak wants to merge 1 commit intomainfrom
codex/update-github-actions-workflows-and-add-checks
Open

Improve CI and docs#184
soumendrak wants to merge 1 commit intomainfrom
codex/update-github-actions-workflows-and-add-checks

Conversation

@soumendrak
Copy link
Owner

Summary

  • run lint and security checks on pull requests
  • show lint status badge and mention test coverage minimum
  • add contributing guidelines with lint, tests, and bandit instructions

Testing

  • uv run pytest -q

https://chatgpt.com/codex/tasks/task_e_685ffe356c48832e8d833d58c4dc36c4

@cloudflare-workers-and-pages
Copy link

Deploying openodia with  Cloudflare Pages  Cloudflare Pages

Latest commit: 7ddce94
Status:🚫  Build failed.

View logs

@codecov
Copy link

codecov bot commented Jun 28, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.49%. Comparing base (ac2db15) to head (7ddce94).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #184   +/-   ##
=======================================
  Coverage   99.49%   99.49%           
=======================================
  Files           9        9           
  Lines         199      199           
=======================================
  Hits          198      198           
  Misses          1        1           
Flag Coverage Δ
pytest 99.49% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ac2db15...7ddce94. Read the comment docs.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@soumendrak soumendrak requested a review from Copilot June 28, 2025 15:09
@soumendrak soumendrak self-assigned this Jun 28, 2025
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR enhances the project's continuous integration and documentation by adding lint and security checks, enforcing test coverage, and providing clear contribution guidelines.

  • Add lint status badge and coverage requirement note to README
  • Create CONTRIBUTING.md with development setup, lint, security scan, and PR instructions
  • Update CI workflow to run on pull requests and include test execution

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
README.md Added lint badge and noted minimum 70% test coverage requirement
CONTRIBUTING.md Introduced contributing guidelines covering setup, lint, tests, and Bandit
.github/workflows/codequality.yml Configured workflow to trigger on PRs and run tests
Comments suppressed due to low confidence (3)

CONTRIBUTING.md:1

  • [nitpick] The initial bullet list appears to be placeholder text that predates the new contributing structure; consider removing or merging it under the '# Contributing' header to avoid duplication.
# Contributing

CONTRIBUTING.md:7

  • [nitpick] The reference to installing 'uv' may be unclear to new contributors; consider adding a brief note or link explaining what 'uv' is or why it's required.
1. Install project dependencies using `uv`:

.github/workflows/codequality.yml:74

  • While tests are run, there's no enforcement of the 70% coverage threshold mentioned elsewhere. Consider adding coverage flags (e.g., pytest --cov --cov-fail-under=70) or a separate step to fail if coverage drops below the minimum.
        uv run pytest -v

@soumendrak soumendrak added the enhancement New feature or request label Jun 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

codex enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants