This document outlines the steps to release a new version of the gem.
- All tests pass:
bundle exec rspec - Code linting passes:
bundle exec rubocop - Documentation is up to date
- CHANGELOG.md is updated with new version and changes
- Version number is updated in
lib/mcp_on_ruby/version.rb - Examples are tested and working
-
Ensure clean working directory
git status
-
Run tests
bundle exec rspec bundle exec rubocop
-
Update version (if not already done)
# Edit lib/mcp_on_ruby/version.rb # Update VERSION constant
-
Update CHANGELOG.md
- Add release date
- Ensure all changes are documented
- Follow Keep a Changelog format
-
Commit version bump
git add -A git commit -m "Bump version to v1.0.0" -
Create git tag
git tag -a v1.0.0 -m "Release version 1.0.0" -
Build the gem
gem build mcp_on_ruby.gemspec
-
Test the gem locally
gem install ./mcp_on_ruby-1.0.0.gem # Create a test Rails app and verify it works -
Push to GitHub
git push origin main git push origin v1.0.0
-
Release to RubyGems
gem push mcp_on_ruby-1.0.0.gem
-
Create GitHub Release
- Go to https://github.com/rubyonai/mcp_on_ruby/releases
- Click "Draft a new release"
- Select the tag v1.0.0
- Title: "v1.0.0 - Production Ready Rails MCP Server"
- Copy the CHANGELOG entries for this version
- Publish release
- Verify gem is available on RubyGems.org
- Test installation:
gem install mcp_on_ruby - Update any example projects
- Announce the release (optional)
We follow Semantic Versioning (https://semver.org/):
- MAJOR version for incompatible API changes
- MINOR version for backwards-compatible functionality additions
- PATCH version for backwards-compatible bug fixes