Custom Rules

Define and enforce project-specific upgrade rules for the Ruby upgrade toolkit.

12|1|Updated Apr 16, 2026
One-click install
npx skills add https://github.com/dhruvasagar/ruby-upgrade-toolkit --skill custom-rules
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: Custom Rules
Source: https://github.com/dhruvasagar/ruby-upgrade-toolkit/tree/main/skills/rules
Command: npx skills add https://github.com/dhruvasagar/ruby-upgrade-toolkit --skill custom-rules

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This feature centralizes and enforces project-specific upgrade policies for Ruby/Rails upgrades, ensuring consistent governance across teams.

Core Features & Use Cases

  • Author and manage per-project rules (id, type, description, and when) that govern upgrades.
  • Validate, list, show, add, remove, disable, enable, and explain rules across gem pins, swaps, private sources, and verification gates.
  • Rely on the shared rules-engine to apply policy overrides and ensure safe upgrade paths.

Quick Start

Create or edit .ruby-upgrade-toolkit/rules.yml, then run /ruby-upgrade-toolkit:rules to view, validate, and activate your rules.

Frequently Asked Questions about Custom Rules

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

FAQPage Schema
How do I define project-specific upgrade rules for Ruby and Rails?

To define project-specific upgrade rules, create or edit the .ruby-upgrade-toolkit/rules.yml file and run the rules command to validate and activate policies governing gem pins, swaps, private sources, and verification gates. This centralizes governance for consistent team upgrades.

What are custom upgrade rules used for in a Ruby upgrade toolkit?

Custom upgrade rules enforce project-specific policies for Ruby and Rails upgrades, ensuring consistent governance across teams. They manage gem pins, swaps, private sources, and verification gates to ensure safe upgrade paths by applying policy overrides through a shared rules-engine.

Can I validate my rules.yml structure against a schema before applying Ruby upgrades?

Yes, the rules feature validates your rules.yml structure against a rules schema. It supports defaults, conflict detection, and credential preflight checks to ensure safe upgrades before you activate any gem pins, swaps, or verification gates.

How do I manage gem pins and swaps during a Rails upgrade?

You can author, validate, show, add, remove, enable, disable, and explain gem pins and swaps using the rules command. This applies project-specific policies from your rules.yml file to ensure safe and governed Rails upgrade paths.

Do I need a shared rules-engine to apply policy overrides for Ruby upgrades?

Yes, the feature relies on a shared rules-engine to apply policy overrides and ensure safe upgrade paths. The engine processes your rules.yml to manage gem pins, swaps, private sources, and verification gates across Ruby and Rails upgrades.

What happens if there are conflicts in my custom upgrade rules?

When conflicts occur in your custom upgrade rules, the validation process detects them during structure validation against the rules schema. It also performs credential preflight checks to prevent unsafe upgrades, ensuring your gem pins and swaps remain safe.