Skip to content

Commit 22e29ba

Browse files
chore: add a small note about pre-release
1 parent 6130477 commit 22e29ba

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,11 +147,15 @@ To release a new version of the MCP server, follow these steps:
147147

148148
1. Ensure there is a Jira _Release_ ticket in the [`MCP` project](https://jira.mongodb.org/projects/MCP) for the new release and move it to _In Progress_.
149149
2. Verify that the Jira tickets you expect to be released are correctly mapped to the _Release_ ticket. Add any additional required documentation to the release ticket.
150-
3. To create a new version, go to the GitHub repository Actions tab and run the "Version Bump" workflow with one of the following options:
150+
3. To create a new version, go to the GitHub repository Actions tab and run the "Prepare Release" workflow with one of the following options:
151151
- `patch` (e.g., 1.0.0 → 1.0.1) for backward-compatible bug fixes
152152
- `minor` (e.g., 1.0.0 → 1.1.0) for backward-compatible new features
153153
- `major` (e.g., 1.0.0 → 2.0.0) for breaking changes
154154
- A specific version number (e.g., `1.2.3`)
155+
- **Pre-release versions**: To create a pre-release, enter the version suffixed by `-prerelease.{n}` where `n` is the pre-release number (e.g., `1.1.0-prerelease.1`, `1.1.0-prerelease.2`). Pre-releases are release candidates that provide early access to new features before they are promoted to stable.
156+
157+
> **Note**: Stable releases are published under the `latest` tag on NPM and are intended for production use. Pre-release versions are published under the `prerelease` tag and serve as release candidates for early access and feedback before being released as stable versions.
158+
155159
4. This creates a pull request with the version change.
156160
5. Merge this pull request if all looks correct. This will trigger the "Publish" workflow which will publish it to **NPM**, **Docker** and the **MCP Registry**.
157161
6. Verify that the new version is published correctly by checking:

0 commit comments

Comments
 (0)