docs: add upgrade-rails skill - #227
Merged
Merged
Conversation
Documents the default_rails_version bump procedure from PR railsdoc#225, including the rails submodule dirty-worktree behavior after `rake build` that's easy to mistake for a problem.
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new Claude skill document to standardize/automate patch-level upgrades of the site’s documented Rails version (updating _config.yml, moving the rails/ submodule tag, and regenerating src/ docs), modeled after PR #225.
Changes:
- Introduce a new
.claudeskill with a step-by-step procedure for patch-leveldefault_rails_versionbumps. - Document workflow pitfalls (submodule “dirty” state after
rake build, pre-flighting tags, and expected commit message formats).
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
switch_default_rails is a prerequisite of the build task, so a bad tag already fails fast before the expensive bundle install / rake rdoc regeneration runs — no separate pre-flight gate is needed. Addresses review comment: railsdoc#227 (comment)
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
Suppressed comments (1)
.claude/skills/upgrade-rails/SKILL.md:80
- This references
mise.tomlas the source of the Ruby version, but there is nomise.tomlin the repo. The Ruby 3.4 requirement appears to be defined in CI workflows instead, so this line is currently misleading for anyone following the skill.
— so the Jekyll build is already validated once this completes. Uses Ruby 3.4 per
`mise.toml`. This is the long step.
mise is a personal toolchain choice, not a repo-wide requirement. Point to ci.yml's ruby-version instead, which is the actual source of truth for the Ruby version this repo targets.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
.claude/skills/upgrade-rails/SKILL.md, a Claude Code skill that automates patch-leveldefault_rails_versionbumps (e.g.8.1.3→8.1.3.1), modeled on PR Update Rails from v8.1.0 to v8.1.3 #225.rails/submodule looking "dirty" afterrake build(expected, not a bug), pre-flighting the target tag before the long build, and the exact (partially unprefixed) commit message pattern from Update Rails from v8.1.0 to v8.1.3 #225.8.1→8.2), which need a different set of_config.yml/ci.ymledits.Test plan
name,description) is valid8.1.3→8.1.3.1upgrade and confirm it produces the same diff shape as Update Rails from v8.1.0 to v8.1.3 #225🤖 Generated with Claude Code