Skip to content

PUBLISH.md

Latest commit

 

History

History
91 lines (64 loc) · 1.71 KB

PUBLISH.md

File metadata and controls

91 lines (64 loc) · 1.71 KB

发布指南

发布到npm

1. 准备工作

确保你已经：

  • 在npm上注册了账号，如https://registry.npmjs.org
  • 登录到npm：npm login --registry https://registry.npmjs.org
  • 更新了package.json中的repository URL
  • 更新了README.md中的GitHub链接
  • 确认本地镜像源一致。使用npm config get registry查看和npm config set registry https://registry.npmjs.org设置

2. 发布步骤

首次发布

# 1. 构建项目
npm run build

# 2. 测试包内容
npm pack --dry-run

# 3. 发布到npm
npm publish

更新版本

# 更新补丁版本 (1.0.0 -> 1.0.1)
npm run version:patch

# 更新小版本 (1.0.0 -> 1.1.0)
npm run version:minor

# 更新大版本 (1.0.0 -> 2.0.0)
npm run version:major

# 发布
npm run publish:npm

发布测试版本

# 发布beta版本
npm run publish:beta

3. 验证发布

发布后可以验证：

# 全局安装测试
npm install -g java-class-analyzer-mcp-server

# 测试命令
java-class-analyzer-mcp --help
java-class-analyzer-mcp config -o test-config.json

4. 用户安装和使用

用户可以通过以下方式安装：

# 全局安装
npm install -g java-class-analyzer-mcp-server

# 本地安装
npm install java-class-analyzer-mcp-server

5. 注意事项

  • 确保每次发布前都运行了 npm run build
  • 检查 .npmignore 文件确保只发布必要的内容
  • 更新版本号后会自动创建git tag
  • 发布前确保所有测试通过
  • 检查生成的配置文件是否正确

6. 故障排除

如果发布失败：

  1. 检查包名是否已被占用
  2. 确保版本号唯一
  3. 检查npm登录状态
  4. 验证package.json配置