Skip to content

Commit 55dfbdc

Browse files
authored
Merge pull request #174 from koic/extract_release_from_readme_to_a_new_file
[Docs] Extract release documentation to RELEASE.md
2 parents 3f5f6f8 + 5b737eb commit 55dfbdc

File tree

2 files changed

+12
-13
lines changed

2 files changed

+12
-13
lines changed

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.

RELEASE.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
## Releases
2+
3+
This gem is published to [RubyGems.org](https://rubygems.org/gems/mcp)
4+
5+
Releases are triggered by PRs to the `main` branch updating the version number in `lib/mcp/version.rb`.
6+
7+
1. **Update the version number** in `lib/mcp/version.rb`, following [semver](https://semver.org/)
8+
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
9+
3. **Create a PR and get approval from a maintainer**
10+
4. **Merge your PR to the main branch** - This will automatically trigger the release workflow via GitHub Actions
11+
12+
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)