Skip to content

Align README badges with package versions and add pytest coverage reporting in CI - #52

Merged
spmse merged 6 commits into
mainfrom
copilot/update-readme-badges
Aug 2, 2026
Merged

spmse merged 6 commits into
mainfrom
copilot/update-readme-badges

Conversation

Copilot AI commented Aug 2, 2026 •

Copy link
Copy Markdown
Contributor

Summary

This updates repository badges to reflect current core/docs package versions and adds PR-visible framework
coverage reporting driven by test runs. CI coverage enforcement is now pytest-based with an 80% floor.

  • Badge updates
    • Added core package version badge (0.2.2)
    • Added docs package version badge (0.2.1)
  • Pytest standardization
    • Configured pytest in packages/core/pyproject.toml
    • Switched core test/coverage scripts from unittest to pytest + pytest-cov
    • Added root-level test script in package.json
  • Coverage + CI behavior
    • Coverage workflow now runs pytest coverage with --cov-fail-under=80
    • Added PR coverage comment reporting
    • Scoped CI test execution to framework code/tests changes only
run: python -m pytest --cov=quickli --cov-report=term-missing --cov-report=xml --cov-fail-under=80

Why

The repo needed badges that reflect actual package versions and framework coverage that is collected from test
execution and surfaced during pull requests. The workflows now enforce coverage expectations and report
coverage deltas in PRs while avoiding unnecessary test runs when framework code/tests are unchanged.

Validation

Describe how you checked the change.

  • python -m ruff check .
  • python -m ruff format --check .
  • python -m pytest
  • python -m build --sdist --wheel
  • Not applicable

Documentation

  • Documentation was updated where needed.
  • No documentation update was needed.

Scope

  • This pull request is focused on one feature or fix.
  • Tests were added or updated for functional changes.
  • Assumptions, risks, or follow-up work are described below.

Risks or follow-up

  • README version badges are static and must be bumped with releases.
  • CI test gating intentionally keys off packages/core/src/** and packages/core/tests/**; changes outside
    those paths will not trigger the test matrix.

Copilot AI linked an issue Aug 2, 2026 that may be closed by this pull request
Copilot AI changed the title [WIP] Update README badges to reflect package versions and coverage Align README badges with package versions and add pytest coverage reporting in CI Aug 2, 2026
Copilot AI requested a review from spmse August 2, 2026 10:13

@spmse spmse left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Ensure that the badge versions are also updated when release please creates release PRs

@spmse
spmse marked this pull request as ready for review August 2, 2026 10:33
@spmse
spmse merged commit 6f7c726 into main Aug 2, 2026
5 checks passed
@spmse
spmse deleted the copilot/update-readme-badges branch August 2, 2026 16:35
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.

Readme badges

2 participants