Skip to content

Commit 5244459

Browse files
authored
doc: update release doc (#5)
1 parent ad22fb6 commit 5244459

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -205,6 +205,36 @@ The Model Context Protocol (MCP) is an open protocol that standardizes how appli
205205

206206
For more information, visit [modelcontextprotocol.io](https://modelcontextprotocol.io/introduction).
207207

208+
## Release
209+
210+
_This section describes how to release a new version of `snmcp`._
211+
212+
1. Generate a tag for the new version (see Versioning, below):
213+
214+
```
215+
git tag -a v0.0.1 -m "v0.0.1"
216+
```
217+
218+
5. Push the tag to the git repository:
219+
220+
```
221+
git push origin refs/tags/v0.0.1
222+
```
223+
224+
The release workflow will:
225+
226+
- build Go binaries for supported platforms
227+
- archive the binaries
228+
- publish a release to the github repository ([ref](https://github.com/streamnative/streamnative-mcp-server/releases))
229+
230+
### Versioning
231+
232+
This project uses [semver](https://semver.org/) semantics.
233+
234+
- Stable: `vX.Y.Z`
235+
- Pre-release: `vX.Y.Z-rc.W`
236+
- Snapshot: `vX.Y.Z-SNAPSHOT-commit`
237+
208238
## License
209239

210240
Licensed under the Apache License Version 2.0: http://www.apache.org/licenses/LICENSE-2.0

0 commit comments

Comments
 (0)