Skip to content

Commit 712f32f

Browse files
committed
[Docs] Extract release documentation to RELEASE.md
A README is generally best 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.
1 parent c152f15 commit 712f32f

1 file changed

Lines changed: 0 additions & 13 deletions

File tree

README.md

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -925,16 +925,3 @@ The client provides a wrapper class for tools returned by the server:
925925
- `MCP::Client::Tool` - Represents a single tool with its metadata
926926

927927
This class provides easy access to tool properties like name, description, input schema, and output schema.
928-
929-
## Releases
930-
931-
This gem is published to [RubyGems.org](https://rubygems.org/gems/mcp)
932-
933-
Releases are triggered by PRs to the `main` branch updating the version number in `lib/mcp/version.rb`.
934-
935-
1. **Update the version number** in `lib/mcp/version.rb`, following [semver](https://semver.org/)
936-
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
937-
1. **Create a PR and get approval from a maintainer**
938-
1. **Merge your PR to the main branch** - This will automatically trigger the release workflow via GitHub Actions
939-
940-
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.

0 commit comments

Comments
 (0)