flow-rc

Enforce non-breaking API rules and validate docs, lint, tsc, tests, and npm packaging for retikz release candidates.

12|2|Updated Nov 27, 2024
One-click install
npx skills add https://github.com/Pionpill/retikz --skill flow-rc
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: flow-rc
Source: https://github.com/Pionpill/retikz/tree/main/.agents/skills/flow-rc
Command: npx skills add https://github.com/Pionpill/retikz --skill flow-rc

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about flow-rc

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I enforce an API freeze during an npm release candidate window?

To enforce an API freeze during an npm release candidate window, you must block breaking changes to component names, props, schema fields, and public function signatures while completing required validation. This ensures no new public capabilities are introduced before the stable release.

What is the release candidate quality freeze process for a TypeScript library?

The release candidate quality freeze process for a TypeScript library coordinates bugfixes, documentation completion, and packaging acceptance while preventing public API modifications. It enforces strict compatibility rules from the rc tag until the final stable version cutoff.

How do I validate npm packaging and TypeScript correctness before publishing a release candidate?

Validate npm packaging and TypeScript correctness before publishing a release candidate by running lint, tsc, and test suites, verifying tarball hygiene, and confirming external install acceptance using the npm next dist-tag strategy.

Can I add new public component props or schema fields when preparing a bugfix for an rc version?

No, you cannot add new public component props or schema fields when preparing a bugfix for an rc version. The release candidate freeze strictly enforces no-breaking and no-new-public-capabilities rules to maintain API compatibility.

What documentation needs to be completed before publishing a 0.1.0-rc.N release?

Before publishing a 0.1.0-rc.N release, you must complete bilingual doc site content with zh as the source of truth, migration guides, examples, and release notes. Docs-first delivery ensures all structural and content requirements are finished.