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: README.md
+60Lines changed: 60 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -254,13 +254,73 @@ npm run inspector http://localhost:8080
254
254
-`npm test` - Run the test suite
255
255
-`npm run format` - Format code with Prettier
256
256
-`npm run inspector` - Run the MCP Inspector against the server
257
+
-`npm run semantic-release` - Run semantic release (automated in CI)
257
258
258
259
### Running Tests
259
260
260
261
```bash
261
262
npm test
262
263
```
263
264
265
+
### Releases
266
+
267
+
This project uses [semantic-release](https://semantic-release.gitbook.io/) for automated versioning and publishing. Releases are automatically created when commits are pushed to the `main` branch using [conventional commit messages](https://www.conventionalcommits.org/).
268
+
269
+
#### Required Secrets
270
+
271
+
For the automated release workflow to function, the following secrets must be configured in the GitHub repository:
272
+
273
+
-`GITHUB_TOKEN` - Automatically provided by GitHub Actions for creating releases and updating the repository
274
+
-`NPM_TOKEN` - Required for publishing packages to npm. Generate this token from your npm account with publish permissions
275
+
276
+
#### Commit Message Format
277
+
278
+
**⚠️ Important:** This project uses automated semantic versioning. The commit message format directly determines version bumps and changelog generation.
279
+
280
+
The project follows the [Conventional Commits](https://www.conventionalcommits.org/) specification. Each commit message must be structured as:
281
+
282
+
```
283
+
<type>[optional scope]: <description>
284
+
285
+
[optional body]
286
+
287
+
[optional footer(s)]
288
+
```
289
+
290
+
**Supported commit types:**
291
+
-`feat:` - new features (triggers **minor** version bump: 1.0.0 → 1.1.0)
0 commit comments