You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+21-20Lines changed: 21 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -76,6 +76,10 @@ npm test -- path/to/test/file.test.ts
76
76
npm test -- path/to/directory
77
77
```
78
78
79
+
#### Accuracy Tests and colima
80
+
81
+
If you use [colima](https://github.com/abiosoft/colima) to run Docker on Mac, you will need to apply [additional configuration](https://node.testcontainers.org/supported-container-runtimes/#colima) to ensure the accuracy tests run correctly.
82
+
79
83
## Troubleshooting
80
84
81
85
### Restart Server
@@ -143,31 +147,28 @@ When adding new tools to the MCP server:
143
147
144
148
## Release Process
145
149
146
-
Our release process is automated using GitHub Actions workflows:
147
-
148
-
### Version Bumping
150
+
To release a new version of the MCP server, follow these steps:
149
151
150
-
1.To create a new version, go to the GitHub repository Actions tab
151
-
2.Select the "Version Bump" workflow
152
-
3.Click "Run workflow" and choose one of the following options:
152
+
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_.
153
+
2.Verify that the Jira tickets you expect to be released are correctly mapped to the expected Release version. Add any additional required documentation to the release ticket.
154
+
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:
153
155
-`patch` (e.g., 1.0.0 → 1.0.1) for backward-compatible bug fixes
154
156
-`minor` (e.g., 1.0.0 → 1.1.0) for backward-compatible new features
155
157
-`major` (e.g., 1.0.0 → 2.0.0) for breaking changes
156
158
- A specific version number (e.g., `1.2.3`)
157
-
4. This creates a pull request with the version change
158
-
5. Once approved and merged, the version is updated
159
-
160
-
### Automatic Publishing
161
-
162
-
When a version bump is merged to the main branch:
163
-
164
-
1. The "Publish" workflow automatically runs
165
-
2. It checks if the version already exists as a git tag
166
-
3. If the version is new, it:
167
-
- Builds the package
168
-
- Publishes to NPM
169
-
- Creates a git tag for the version
170
-
- Creates a GitHub release with auto-generated release notes
159
+
-**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.
160
+
161
+
> **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.
162
+
163
+
4. This creates a pull request with the version change.
164
+
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**.
165
+
6. Verify that the new version is published correctly by checking:
8. Go to the [Releases](https://jira.mongodb.org/projects/MCP?selectedItem=com.atlassian.jira.jira-projects-plugin%3Arelease-page&status=released-unreleased) section the and rename the `vNext` to the new version number and mark it as Released. Create a new `vNext` for the next release.
171
+
9. Post an update in the `#mongodb-mcp` Slack channel.
0 commit comments