Skip to content

PUBLISH.md

Latest commit

 

History

History
189 lines (126 loc) · 3.63 KB

PUBLISH.md

File metadata and controls

189 lines (126 loc) · 3.63 KB

发布到 npm 的指南

📋 发布前检查清单

在发布之前，请确保完成以下步骤：

1. 更新 package.json 中的个人信息

编辑 package.json，修改以下字段：

{
  "author": "Your Name <your.email@example.com>",
  "repository": {
    "type": "git",
    "url": "https://github.com/yourusername/cccp.git"
  },
  "bugs": {
    "url": "https://github.com/yourusername/cccp/issues"
  },
  "homepage": "https://github.com/yourusername/cccp#readme"
}

2. （可选）修改包名

如果 mcp-cccp-server 已被占用，可以修改包名：

{
  "name": "@yourusername/cccp",  // 使用 scope 包名
  // 或
  "name": "your-unique-package-name"
}

3. 确保测试通过

npm test

4. 本地测试打包

# 查看将要发布的文件
npm pack --dry-run

# 实际打包（生成 .tgz 文件）
npm pack

# 在本地测试安装
npm install -g ./mcp-cccp-server-1.0.0.tgz

🚀 发布步骤

方法 1：首次发布

1. 登录 npm

npm login

输入你的 npm 账号、密码和邮箱。

2. 发布包

npm publish

如果使用 scope 包名（如 @yourusername/cccp），需要添加 --access public：

npm publish --access public

3. 验证发布成功

访问：https://www.npmjs.com/package/mcp-cccp-server（替换为你的包名）

方法 2：更新已发布的包

1. 修改版本号

# 补丁版本（1.0.0 -> 1.0.1）
npm version patch

# 次要版本（1.0.0 -> 1.1.0）
npm version minor

# 主要版本（1.0.0 -> 2.0.0）
npm version major

2. 发布新版本

npm publish

📦 发布后的使用

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

全局安装

npm install -g mcp-cccp-server

本地安装

npm install mcp-cccp-server

使用 npx（无需安装）

claude mcp add --transport stdio cccp -- npx -y mcp-cccp-server

🔄 撤销发布

注意：npm 只允许在发布后 72 小时内撤销包。

npm unpublish mcp-cccp-server@1.0.0

📊 查看包信息

# 查看包详情
npm view mcp-cccp-server

# 查看包的所有版本
npm view mcp-cccp-server versions

# 查看包的下载统计
npm view mcp-cccp-server dist.tarball

🛠️ 常见问题

1. 包名已被占用

错误：403 Forbidden - PUT https://registry.npmjs.org/mcp-cccp-server - You do not have permission to publish

解决方案：修改 package.json 中的 name 字段，使用 scope 包名或其他唯一名称。

2. 需要登录

错误：401 Unauthorized - PUT https://registry.npmjs.org/...

解决方案：运行 npm login 登录你的 npm 账号。

3. 版本号冲突

错误：403 Forbidden - PUT ... - You cannot publish over the previously published versions

解决方案：使用 npm version 命令更新版本号。

📝 版本管理最佳实践

  • 补丁版本（1.0.x）：修复 bug、小的改进
  • 次要版本（1.x.0）：新增功能，保持向后兼容
  • 主要版本（x.0.0）：破坏性更改，不向后兼容

🎯 发布检查清单

  • 更新了 package.json 中的个人信息
  • 运行 npm test 确保测试通过
  • 运行 npm pack --dry-run 检查打包内容
  • 登录了 npm 账号（npm login）
  • 确认版本号正确
  • 运行 npm publish
  • 在 npmjs.com 上验证发布成功
  • 测试从 npm 安装包

🔗 有用的链接