What problem does it solve?
flow-rc solves the risk of breaking the public API during the npm rc (release candidate) quality-freeze window by enforcing strict non-breaking and no-new-public-capabilities rules while driving the necessary documentation, validation, and release preparation.
Core Features & Use Cases
- API Freeze Governance: Prevents breaking changes to component names, props, IR/schema fields, export types, and public function signatures during the rc period.
- Docs-First Delivery: Coordinates doc site structure/content completion, bilingual consistency (zh as source of truth), migration guides, examples quality, and release notes.
- Release & Packaging Readiness: Ensures npm
next dist-tag installability, tarball hygiene, TypeScript correctness, and external smoke-test viability before publishing rc.
- Suitable Scenarios: bugfix (non-breaking), documentation updates, packaging/installation acceptance, and changelog/release-note work for versions in the
0.1.0-rc.N to stable cutoff.
Quick Start
Use flow-rc to verify and complete all rc documentation and packaging acceptance for version 0.1.0-rc.N while rejecting any proposed public API or schema-breaking changes.