Declare Beta maturity and start the path to 1.0.0#59
Conversation
Add the Development Status :: 4 - Beta classifier and a public Stability & versioning section (README + README.es) that states what the 1.0.0 contract covers (rules.yaml schema, .bec.yaml bundle format, check names, CLI commands and exit codes, check --json shape, MCP signatures) and the exit criteria to reach it.
Add an optional top-level schema_version to .bec/rules.yaml. Absent means 1, so every existing file keeps loading unchanged. becwright init stamps the current version, and load_rules refuses a file stamped newer than the engine understands with a clear 'upgrade becwright' error instead of risking a silent misparse. No migration code yet — that is added when a v2 format actually exists. This closes the on-disk-format half of the path to 1.0.0: the .bec.yaml export bundle was already versioned via becwright_bec; rules.yaml was the remaining unversioned format.
Document the exit codes (0 pass / 1 a blocking rule failed / 2 config or usage problem) and the check --json output shape in documentation/usage.md (and .es), plus the optional schema_version top-level key. Lock both the exit-code-2 paths (unknown built-in check, malformed rules.yaml) and the JSON key sets (payload + rule_record) with contract tests, so any change to the shape is a deliberate, reviewed break instead of a silent drift. Advances the path to 1.0.0: exit codes and check --json are now a stated, test-enforced contract.
|
Warning Review limit reached
Next review available in: 54 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (11)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
1 participant
What & why
Answers "are our releases stable?" honestly: they are functionally solid (green suite, published on npm+PyPI, dogfooded) but we never declared maturity or committed to a stability contract. This PR declares Beta, publishes a concrete path to
1.0.0, and knocks out the first substantive items on that path.Changes
Declare Beta + publish the plan (
chore)pyproject.toml: add theDevelopment Status :: 4 - Betaclassifier.README.md/README.es.md: new Stability & versioning section — what the1.0.0contract covers and the exit criteria to get there.CHANGELOG.md:[Unreleased]entries.Version the
.bec/rules.yamlformat (feat).bec.yamlexport bundle was already versioned (becwright_bec); the real unversioned format was.bec/rules.yaml. Corrected the checklist accordingly.schema_version(absent means1, so existing files keep working).becwright initstamps it;load_rulesrefuses a file stamped newer than the engine understands with a clear "upgrade becwright" error. No migration code yet (YAGNI until a v2 exists).Document + lock the stable CLI contract (
docs)documentation/usage.md(+.es): the exit codes (0pass /1a blocking rule failed /2config or usage problem), thecheck --jsonoutput shape, and theschema_versionkey.2paths and the JSON key sets (payload+rule_record), so any shape change is a deliberate, reviewed break rather than a silent drift.Path to 1.0.0 (checklist state after this PR)
rules.yamlfield set.check --jsonshape.Test plan
pytest— 251 passing (+10 new acrossschema_version,initstamping, exit codes, JSON key contracts).becwright initwritesschema_version: 1; a file stamped99is rejected with the upgrade error.schema_versionload unchanged.