flowfile-change-control

Manage classification, gating, versioning, and release of Flowfile monorepo changes.

340|27|Updated Nov 9, 2024
One-click install
npx skills add https://github.com/Edwardvaneechoud/Flowfile --skill flowfile-change-control
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: flowfile-change-control
Source: https://github.com/Edwardvaneechoud/Flowfile/tree/main/.claude/skills/flowfile-change-control
Command: npx skills add https://github.com/Edwardvaneechoud/Flowfile --skill flowfile-change-control

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires bump_version.py, check_stubs, check_formula_docs, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill ensures proper classification, versioning, and release of changes in the Flowfile monorepo, preventing issues with app versions, API stabs, and dependency pins.

Core Features & Use Cases

  • Version Control Automation: Automated version lockstep bumping and checking to maintain consistency across various manifest files.
  • API Stability: Checks and gates to maintain API stabiliy of the flowfile_frame public API.
  • Dependency Management: Deliberate pinning of critical dependencies like FastAPI and Polars.
  • Release Mechanisms: Provides detailed guidelines on release preparation, version tagging, and automated Docker image and PyPI package builds.

Quick Start

Run the bump_version.py script to automatically update version manifests across the Flowfile project and commit the changes.

Frequently Asked Questions about flowfile-change-control

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

FAQPage Schema
How do I automate version manifest synchronization in a monorepo?

Version manifest synchronization in a monorepo is automated by running the bump_version.py script, which updates version manifests across the project and checks for consistency before committing changes.

How does API stability checking work for public APIs?

API stability checking works by validating API stubs against defined public interfaces, ensuring that changes do not break existing contracts and gating releases that violate API stability rules.

What is the best way to manage dependency pinning for FastAPI and Polars?

Dependency pinning for FastAPI and Polars is managed through deliberate version constraints enforced during the release process, preventing unexpected breaking changes from upstream updates.

How do I prepare a release with version tagging and automated builds?

Release preparation with version tagging and automated builds is handled by following detailed release guidelines, managing tags, and triggering automated Docker image and PyPI package builds.

Why do I need branch protection and release checklists for version control?

Branch protection and release checklists are needed for version control to enforce governance, ensuring that all changes pass classification, API stub checks, and dependency validation before release.