Skip to content

Fix stale v0.0.100 version string and add README to version sync check#375

Merged
aallan merged 5 commits into
mainfrom
fix/readme-version-string
Mar 27, 2026
Merged

Fix stale v0.0.100 version string and add README to version sync check#375
aallan merged 5 commits into
mainfrom
fix/readme-version-string

Conversation

@aallan

@aallan aallan commented Mar 27, 2026

Copy link
Copy Markdown
Owner

Two related fixes:

  • README.md Project Status: stale v0.0.100v0.0.101
  • scripts/check_version_sync.py: README.md was not included in the version sync check, which is how the stale string slipped through in the first place. Now checks all four version-bearing files: pyproject.toml, vera/__init__.py, docs/index.html, and README.md
  • Roadmap narrative: removed strikethroughs from the Markdown, Json, Http, Inference sentence — the issue links carry the meaning, strikethroughs are visual noise in prose

Summary by CodeRabbit

  • Documentation

    • Updated the project status version marker to v0.0.101 in the README.
    • Reformatted the roadmap to list Markdown, Json, Http and Inference as active items.
    • Clarified the example run instruction to reference the example path explicitly.
  • Chores

    • Added a version-sync check that reads the README version and fails with an error if the version pattern is missing.

Co-Authored-By: Claude <noreply@anthropic.invalid>
@coderabbitai

coderabbitai Bot commented Mar 27, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 9824eb23-c798-4727-a99e-0d0c3075feea

📥 Commits

Reviewing files that changed from the base of the PR and between 705d744 and a265d37.

📒 Files selected for processing (1)
  • scripts/check_version_sync.py

📝 Walkthrough

Walkthrough

Updated README content (version bump, roadmap formatting, example invocation) and augmented the CI script scripts/check_version_sync.py to extract a semantic version from README.md, include it in the cross-file version consistency check, and fail with an error if no version is found.

Changes

Cohort / File(s) Summary
Documentation
README.md
Bumped "Project Status" from v0.0.100v0.0.101; removed strikethroughs from roadmap entries (Markdown, Json, Http, Inference); adjusted example invocation to vera run with an explicit examples/inference.vera link.
CI / Version check script
scripts/check_version_sync.py
Reads README.md to extract a semantic version matching at vX.Y.Z, adds that entry to the versions map used for uniqueness checking, and exits with an error (writes to stderr and returns non-zero) if the README version pattern is not found.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Suggested labels

docs, ci

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly and accurately describes the two primary changes: fixing the stale v0.0.100 version string in README.md and adding README to the version sync check.

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

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/readme-version-string

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

@codecov

codecov Bot commented Mar 27, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.30%. Comparing base (3316499) to head (a265d37).
⚠️ Report is 6 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #375   +/-   ##
=======================================
  Coverage   90.30%   90.30%           
=======================================
  Files          49       49           
  Lines       19100    19100           
  Branches      220      220           
=======================================
  Hits        17248    17248           
  Misses       1848     1848           
  Partials        4        4           
Flag Coverage Δ
javascript 50.58% <ø> (ø)
python 95.31% <ø> (ø)

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

aallan and others added 2 commits March 27, 2026 16:57
The issue links carry the meaning — strikethroughs are visual noise in prose.

Co-Authored-By: Claude <noreply@anthropic.invalid>
Co-Authored-By: Claude <noreply@anthropic.invalid>

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Line 603: The README states v0.0.101 but the project must keep version numbers
synchronized across all version-bearing files; open vera/__init__.py and set the
module __version__ to "0.0.101", open pyproject.toml and update the project
version = "0.0.101", and update CHANGELOG.md so the latest release header (and
any internal references) show v0.0.101 to match README.md; after editing run a
quick grep for "0.0." to ensure no other files still reference a different patch
version.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 3c7da5ac-5140-46cd-b9af-4561b71be272

📥 Commits

Reviewing files that changed from the base of the PR and between a028ceb and b459f6e.

📒 Files selected for processing (1)
  • README.md

Comment thread README.md
The "active development at vX.Y.Z" string in README.md was not covered,
which is how the v0.0.100 string slipped through to PR #375.

Co-Authored-By: Claude <noreply@anthropic.invalid>
@aallan aallan changed the title Fix stale v0.0.100 version string in README Project Status Fix stale v0.0.100 version string and add README to version sync check Mar 27, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@scripts/check_version_sync.py`:
- Around line 44-50: The README version extraction currently logs a warning and
continues when no match is found; change this to fail the script: in the block
that reads README.md (variables readme, match, and versions["README.md"]), when
match is None print an error to stderr and call sys.exit(1) (or raise
SystemExit(1)) so the CI returns non-zero instead of omitting README.md from
versions.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: c33ad71e-1be9-42c0-a53d-51ae3825969e

📥 Commits

Reviewing files that changed from the base of the PR and between b459f6e and 705d744.

📒 Files selected for processing (1)
  • scripts/check_version_sync.py

Comment thread scripts/check_version_sync.py Outdated
WARNING + continue means a missing match silently skips README.md
from the version set, so the check can pass with a gap. Return 1
instead, matching the behaviour of the other required-file checks.

Co-Authored-By: Claude <noreply@anthropic.invalid>
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.

1 participant