skills.rest
pikkujs
pikkujsOFFICIAL
Explore all skills by this author →
WebsiteGitHub

pikku-versioning

Hash Pikku function schemas into a versions.json manifest for CI checks.

56|Updated Apr 18, 2021
Search Tags:#versioning#breaking-changes#contracts#ci#versions.json#pikku
One-click install
npx skills add https://github.com/pikkujs/pikku --skill pikku-versioning
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: pikku-versioning
Source: https://github.com/pikkujs/pikku/tree/main/.claude/skills/pikku-versioning
Command: npx skills add https://github.com/pikkujs/pikku --skill pikku-versioning

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Tracking and enforcing backward-compatible Pikku function contracts across releases by hashing input/output schemas into a versions.json manifest, enabling teams to catch breaking changes early.

Core Features & Use Cases

  • Version manifest management: generate and validate contract hashes for each function version.
  • CI integration: automatically detect breaking changes during PRs and enforce version bumps.
  • Workflow guidance: initialize manifest, bump versions on breaking changes, and update hashes.

Quick Start

Initialize the versions manifest and bump the function version whenever a contract changes.

Frequently Asked Questions about pikku-versioning

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

FAQPage Schema
How do I track breaking changes in function contracts during CI?▼

Track breaking changes in function contracts by hashing input and output schemas into a versions.json manifest. Applying this to CI workflows automatically detects unversioned breaking changes and enforces version bumps during pull requests.

What is a versions.json manifest used for in API versioning?▼

A versions.json manifest stores hashed input and output schemas to manage API versioning. It tracks backward-compatible function contracts across releases, enabling automated checks to catch breaking changes early before deployment.

How do I initialize version tracking for Pikku function contracts?▼

Initialize version tracking for Pikku function contracts by generating a versions.json manifest using the provided CLI commands. This establishes a baseline of hashed schemas to validate against future project updates.

Do I need to bump function versions when modifying input or output schemas?▼

Yes, you need to bump function versions whenever an input or output schema changes. The workflow guidance ensures that modifying contracts triggers a version increment to maintain backward compatibility across releases.

Can I integrate contract version management directly into automated workflows?▼

Yes, you can integrate contract version management directly into automated CI workflows. The system automatically detects breaking changes during pull requests and enforces required version bumps to ensure consistency across releases.

What happens if a breaking change is detected without a version bump?▼

When a breaking change is detected without a version bump, the CI integration automatically flags the inconsistency. This enforcement mechanism ensures that schema modifications are explicitly versioned before merging.

Related Skills

Explore More Software Engineering Skills→
AgentientAgentient
2

mcp-pydantic-tool-definition

Define MCP tool schemas with Pydantic models and strict validation.

Official
Advanced
hetsheth-droidhetsheth-droid

ship

Automate the ship workflow from base branch detection to PR creation.

Community
Advanced
jellyrockjellyrock
37

dep-major

Standardize major dependency bump reviews for JellyRock Roku applications.

Official
Advanced
pacphipacphi
6

contract-testing

Automate consumer-driven contract testing for microservices and API contracts.

Community
Advanced