diff --git a/README.md b/README.md index 5ffd8d2..3958751 100644 --- a/README.md +++ b/README.md @@ -925,16 +925,3 @@ The client provides a wrapper class for tools returned by the server: - `MCP::Client::Tool` - Represents a single tool with its metadata This class provides easy access to tool properties like name, description, input schema, and output schema. - -## Releases - -This gem is published to [RubyGems.org](https://rubygems.org/gems/mcp) - -Releases are triggered by PRs to the `main` branch updating the version number in `lib/mcp/version.rb`. - -1. **Update the version number** in `lib/mcp/version.rb`, following [semver](https://semver.org/) -1. **Update CHANGELOG.md**, backfilling the changes since the last release if necessary, and adding a new section for the new version, clearing out the Unreleased section -1. **Create a PR and get approval from a maintainer** -1. **Merge your PR to the main branch** - This will automatically trigger the release workflow via GitHub Actions - -When changes are merged to the `main` branch, the GitHub Actions workflow (`.github/workflows/release.yml`) is triggered and the gem is published to RubyGems. diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 0000000..7e6a047 --- /dev/null +++ b/RELEASE.md @@ -0,0 +1,12 @@ +## Releases + +This gem is published to [RubyGems.org](https://rubygems.org/gems/mcp) + +Releases are triggered by PRs to the `main` branch updating the version number in `lib/mcp/version.rb`. + +1. **Update the version number** in `lib/mcp/version.rb`, following [semver](https://semver.org/) +2. **Update CHANGELOG.md**, backfilling the changes since the last release if necessary, and adding a new section for the new version, clearing out the Unreleased section +3. **Create a PR and get approval from a maintainer** +4. **Merge your PR to the main branch** - This will automatically trigger the release workflow via GitHub Actions + +When changes are merged to the `main` branch, the GitHub Actions workflow (`.github/workflows/release.yml`) is triggered and the gem is published to RubyGems.