Skip to content

Commit 73f7755

Browse files
committed
chore: update release process documentation
This uses the wording from the mongosh release process to better direct our process with Jira and publicizing our release.
1 parent 34c9c68 commit 73f7755

File tree

1 file changed

+11
-19
lines changed

1 file changed

+11
-19
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -143,31 +143,23 @@ When adding new tools to the MCP server:
143143

144144
## Release Process
145145

146-
Our release process is automated using GitHub Actions workflows:
146+
To release a new version of the MCP server, follow these steps:
147147

148-
### Version Bumping
149-
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:
148+
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_.
149+
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:
153151
- `patch` (e.g., 1.0.0 → 1.0.1) for backward-compatible bug fixes
154152
- `minor` (e.g., 1.0.0 → 1.1.0) for backward-compatible new features
155153
- `major` (e.g., 1.0.0 → 2.0.0) for breaking changes
156154
- 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:
155+
4. This creates a pull request with the version change.
156+
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**.
157+
6. Verify that the new version is published correctly by checking:
158+
- NPM: https://www.npmjs.com/package/mongodb-mcp-server
159+
- Docker: https://hub.docker.com/r/mongodb/mongodb-mcp-server
160+
- MCP Registry: `curl "https://registry.modelcontextprotocol.io/v0.1/servers/io.github.mongodb-js%2Fmongodb-mcp-server/versions/latest"`
161+
7. Close the Jira ticket for the release and post an update in the `#mongodb-mcp` Slack channel.
163162

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
171163

172164
### Code Quality
173165

0 commit comments

Comments
 (0)