igmarin/rails-engine-release
rails-engine-release/SKILL.md
Use when preparing a Rails engine gem release. Generates CHANGELOG.md entries, produces step-by-step upgrade notes for host apps, sets semantic version constants, verifies gemspec metadata, confirms test suite passes, and sequences gem build and publish commands. Trigger words: version bump, changelog, deprecation, gemspec, upgrade, migration guide, release, publish gem, ship gem, verify gemspec, test suite.
$ install --global
skillsauthnpx skillsauth add igmarin/rails-agent-skills rails-engine-releaseInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
Security Scan Results
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
3
Scanners Passed
9
Scanners in report
Clean
TrivyContainer and dependency vulnerability scanner
95%
Clean
SemgrepStatic code analysis for vulnerabilities
95%
Clean
mcp-scan (Snyk)Model Context Protocol security validation
95%
Skipped
Snyk (dep)Open source security scanning
50%
Skipped
Socket.devSupply chain security analysis
50%
Skipped
VirusTotalMulti-engine malware detection
50%
Skipped
CrowdStrikeAdvanced threat intelligence
50%
Skipped
OSV-ScannerOpen Source Vulnerability database check
50%
Skipped
OWASP Dep-Check
50%
Last scanned: Apr 30, 2026, 4:46 PM17.2s1 file scanned
SKILL.md
- name:
- rails-engine-release
- license:
- MIT
- description:
- >
- and publish commands. Trigger words:
- version bump, changelog, deprecation,
Rails Engine Release
Use this skill when the task is to ship a Rails engine as a gem or prepare a new version.
Release work should make upgrades predictable for host applications.
Quick Reference
| Release Step | Action | |--------------|--------| | Version bump | Patch (bug fixes), Minor (new features), Major (breaking changes); update version constant once | | Changelog | Document user-visible changes, not commits; group by Added/Changed/Fixed/Deprecated | | Deprecations | Document removal plan and replacement; keep deprecated code for at least one minor cycle | | Gemspec | Verify metadata, dependencies, and tested Rails/Ruby versions match constraints |
HARD-GATE
DO NOT release without updating CHANGELOG and version file.
Release Order
- Confirm scope and compatibility impact — is this patch, minor, or major?
- Run full test suite:
bundle exec rspec. Fix all failures before proceeding. - Set the version bump — update the version constant once:
module MyEngine; VERSION = "1.2.0"; endinlib/my_engine/version.rb. - Update changelog and upgrade notes.
- Verify gemspec metadata and dependencies match tested Rails/Ruby versions.
- Dry-run the gem build:
gem build *.gemspec && gem push --dry-run *.gem. Verify contents. - Confirm installation docs and README match the release — update if needed.
- Publish:
gem push *.gem.
Versioning Rules
- Patch: bug fixes and internal changes without public behavior breakage.
- Minor: backward-compatible features and new extension points.
- Major: breaking changes to API, setup, routes, migrations, configuration, or supported framework versions.
If the engine requires host changes during upgrade, document them explicitly even if the version bump is minor.
Examples
## [1.2.0] - 2024-03-15
### Added
- `widget_count` config option to limit dashboard widgets (default: 10).
### Changed
- Minimum Rails version is now 7.0.
See EXAMPLES.md for a full changelog entry and upgrade note template.
Extended Resources (Progressive Disclosure)
Load these files only when their specific content is needed:
- assets/release_checklist.md — Use when you need a detailed step-by-step verification checklist before finalizing the release
- assets/release_notes_template.md — Use when drafting GitHub release notes or long-form release announcements
- assets/examples.md — Reference for how to use the supporting templates
Output Style
When asked to prepare a release, produce a release summary ready for team lead review, with code blocks for all file changes. It MUST include:
- Version bump recommendation — New version (patch/minor/major) with explicit reasoning
- Version constant — Updated
lib/<engine>/version.rbwith the newVERSION = "x.y.z" - CHANGELOG entries — User-facing changes under Added/Changed/Fixed/Deprecated headers
- Upgrade notes — Steps host apps must take (config changes, migration steps, dependency updates)
- Gemspec verification — Confirm metadata, files, and dependencies match tested Rails/Ruby versions
- Test suite status — Confirm
bundle exec rspecpasses before proceeding to build - Release blockers — Open issues preventing release, or explicitly state "No blockers"
Integration
| Skill | When to chain | |-------|---------------| | rails-engine-docs | When updating README, setup instructions, or API docs for the release | | rails-engine-compatibility | When verifying Rails/Ruby version support or deprecation impact | | rails-engine-testing | When ensuring tests pass before release and match documented behavior |
Related Skills
igmarin/rails-agent-skills
development
VerifiedTrustedCommunity
Entry point for Rails development workflows covering TDD, RSpec, Service Objects, DDD, GraphQL, Engines, and Code Quality. Use when the user asks about Ruby on Rails development patterns, needs RSpec test suites generated, wants service objects scaffolded, is setting up GraphQL schemas, performing Rails code review, refactoring .rb files, working with domain-driven design, implementing background jobs, conducting Rails security checks, or building Rails engines. Generates RSpec tests, structures service objects, enforces TDD workflows, configures GraphQL schemas, and coordinates domain-driven design patterns. Trigger keywords: Rails, RSpec, TDD, Rails testing, Rails refactor, Rails API, Rails code review, domain driven design, service objects, GraphQL, Rails engine, Ruby, .rb, background jobs, Rails migrations, Rails security check.
21SKILL.mdUpdated May 18, 2026
igmarin/release-engine
development
VerifiedTrustedCommunity
Use when shipping a Rails engine gem — FIRST run full test suite (`bundle exec rspec`) and fix ALL failures, verify gemspec metadata and dependencies match tested Rails/Ruby versions, dry-run: `gem build *.gemspec && gem push --dry-run *.gem` and verify contents, generate CHANGELOG.md organized by category (added/changed/deprecated/removed/fixed), produce step-by-step upgrade notes with before/after code, set semantic version in `lib/[engine_name]/version.rb`, document deprecations with migration paths, load release assets conditionally and state which one informed the output. Trigger words: version bump, changelog, deprecation, gemspec, upgrade, release, publish gem, ship gem.
21SKILL.mdUpdated May 9, 2026
igmarin/tdd
development
VerifiedTrustedCommunity
Orchestrates the full Rails TDD cycle with hard gates: test MUST exist, be run, and FAIL for the correct reason (e.g. undefined method, not syntax error) before any implementation code — propose minimal implementation and wait for user approval → verify test PASSES → run full suite with rubocop, brakeman, rspec all green → produce YARD documentation and self-reviewed PR; phases context/test design→implementation→iterate→finish. Use when practicing test-driven development, red-green-refactor, TDD workflow, writing tests before code, adding tests first, or building a Rails feature where specs must gate implementation.
19SKILL.mdUpdated Jun 5, 2026
igmarin/setup
development
VerifiedTrustedCommunity
Complete Rails project setup loop with hard gates: verify Ruby version matches .ruby-version, Bundler installed, database connection successful, all env vars loaded, and ALL external CI actions pinned to immutable commit SHAs (never mutable tags like @v4) → configure CI/CD pipeline with linting, testing, and security scanning → validate end-to-end with bundle install, db:create, db:migrate, rspec, and write SETUP_CHECKLIST.md; phases context/onboarding→CI/CD configuration→environment validation. Use when starting a new Rails project, running `rails new`, configuring a Gemfile or .ruby-version, setting up a development environment, or wiring up CI/CD for a Ruby on Rails app. Trigger: setup project, new Rails app, configure CI/CD, dev environment setup, rails new, Gemfile setup, .ruby-version, Ruby on Rails project bootstrap.
19SKILL.mdUpdated Jun 5, 2026