Skip to content

Commit bbd4e82

Browse files
committed
docs: add release process documentation to README
1 parent 40edb69 commit bbd4e82

File tree

3 files changed

+32
-3
lines changed

3 files changed

+32
-3
lines changed

README.md

+9
Original file line numberDiff line numberDiff line change
@@ -216,6 +216,15 @@ This project follows Test-Driven Development practices. Each new feature should:
216216
2. Implement the minimal code to make the test pass
217217
3. Refactor while keeping tests green
218218

219+
## Release Process
220+
221+
This project uses [Conventional Commits](https://www.conventionalcommits.org/) to automate versioning and changelog generation. When contributing, please follow the commit message convention.
222+
223+
To create a commit with the correct format, use:
224+
```bash
225+
npm run commit
226+
```
227+
219228
## License
220229

221230
MIT

commitlint.config.js

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
// commitlint.config.js
2+
module.exports = {
3+
extends: ['@commitlint/config-conventional'],
4+
};

package.json

+19-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
11
{
2-
"name": "azure-devops-mcp",
2+
"name": "@tiberriver256/mcp-server-azure-devops",
33
"version": "0.1.0",
44
"description": "Azure DevOps reference server for the Model Context Protocol (MCP)",
55
"main": "dist/index.js",
66
"types": "dist/index.d.ts",
7+
"config": {
8+
"commitizen": {
9+
"path": "./node_modules/cz-conventional-changelog"
10+
}
11+
},
712
"scripts": {
813
"build": "tsc",
914
"dev": "ts-node-dev --respawn --transpile-only src/index.ts",
@@ -16,7 +21,13 @@
1621
"test:watch": "jest --watch",
1722
"lint": "eslint . --ext .ts",
1823
"format": "prettier --write \"src/**/*.ts\" \"tests/**/*.ts\"",
19-
"prepare": "husky install"
24+
"prepare": "husky install",
25+
"commit": "cz",
26+
"release": "standard-version",
27+
"release:minor": "standard-version --release-as minor",
28+
"release:patch": "standard-version --release-as patch",
29+
"release:major": "standard-version --release-as major",
30+
"release:dryrun": "standard-version --dry-run"
2031
},
2132
"keywords": [
2233
"azure-devops",
@@ -35,16 +46,21 @@
3546
"zod": "^3.24.2"
3647
},
3748
"devDependencies": {
49+
"@commitlint/cli": "^19.8.0",
50+
"@commitlint/config-conventional": "^19.8.0",
3851
"@types/jest": "^29.5.0",
3952
"@types/node": "^20.0.0",
4053
"@typescript-eslint/eslint-plugin": "^8.27.0",
4154
"@typescript-eslint/parser": "^8.27.0",
55+
"commitizen": "^4.3.1",
56+
"cz-conventional-changelog": "^3.3.0",
4257
"eslint": "^8.0.0",
4358
"eslint-config-prettier": "^9.0.0",
4459
"eslint-plugin-prettier": "^5.0.0",
45-
"husky": "^8.0.0",
60+
"husky": "^8.0.3",
4661
"jest": "^29.0.0",
4762
"prettier": "^3.0.0",
63+
"standard-version": "^9.5.0",
4864
"ts-jest": "^29.0.0",
4965
"ts-node-dev": "^2.0.0",
5066
"typescript": "^5.8.2"

0 commit comments

Comments
 (0)