From 5b737eb9c3ca5ed10a37382ea3ad48f591c4683b Mon Sep 17 00:00:00 2001 From: Koichi ITO Date: Thu, 30 Oct 2025 07:59:28 +0800 Subject: [PATCH] [Docs] Extract release documentation to RELEASE.md README is generally better kept focused on information that is most valuable to users. For that reason, release procedures that are not relevant to end users have been moved to a separate RELEASE.md file. --- README.md | 13 ------------- RELEASE.md | 12 ++++++++++++ 2 files changed, 12 insertions(+), 13 deletions(-) create mode 100644 RELEASE.md diff --git a/README.md b/README.md index 5ffd8d2a..39587519 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 00000000..7e6a0476 --- /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.