如何发布npm包并配置CI/CD

生成访问令牌

1. 登录 npm 账户：打开浏览器，进入 https://www.npmjs.com/login。

2. 创建新令牌：

   • 登录后，点击右上角的用户头像。
   • 在下拉菜单中选择“Access Tokens”（访问令牌）。
   • 点击页面上的“New Access Token”按钮。
   • 为令牌输入一个描述，例如：“GitHub Actions”。

3. 下载并保存令牌：

   • 勾选需要的权限，如“Read packages”和“Write packages”。
   • 点击“Create Token”（创建令牌）按钮。
   • 立即复制生成的令牌，并安全地保存下来。

4. 设置 GitHub Secrets：

   • 打开你的 GitHub 仓库，在左侧菜单中选择“Settings”（设置）。
   • 在“Secrets”部分，点击“Add a secret”按钮。
   • 输入NPM_TOKEN作为秘密名称，粘贴刚才生成的令牌值并保存。

配置 Docker Hub 秘密

1. 登录 Docker 账户：访问 https://hub.docker.com 并使用你的账号登录。

2. 创建新令牌：

   • 进入“Account Settings”（账户设置）。
   • 选择左侧菜单中的“Security”（安全）。
   • 点击“New Access Token”（新建访问令牌），并为令牌添加描述，例如：“GitHub Actions”。

3. 获取 Docker 账户信息：

   • 记录下你的 Docker Hub 用户名，通常显示在你的个人资料页面上。

4. 设置 GitHub Secrets：

   • 返回到 GitHub 仓库的“Secrets”部分。
   • 添加两个新的秘密：DOCKERHUB_USERNAME（输入你的 Docker 账户名）和 DOCKERHUB_TOKEN（粘贴刚才生成的 Docker Hub 令牌）。

验证配置

1. 运行工作流程：

   • 在 GitHub 仓库中，找到“Actions”标签。
   • 展开左侧菜单，选择相应的 CI/CD 工作流程。
   • 点击“Run workflow”按钮，并在分支下拉框中选择main分支。
   • 观察工作流程运行状态，在其完成后检查是否有错误或警告信息。

2. 确认发布成功：

   • 在 npm 仓库 https://www.npmjs.com 中，搜索你的包名称。
   • 确认新版本已正确发布，并且包含最新的代码变更。

3. 验证 Docker 镜像：

   • 访问 https://hub.docker.com，查看是否成功构建并发布了新的 Docker 镜像。
   • 可以通过搜索镜像名称来确认其存在。

注意事项

• 2FA 用户：如果你启用了双因素认证（2FA），需要使用“Automation”类型的令牌，或暂时禁用 2FA 来自动化发布流程。
• 更新包版本：
  • 使用语义化版本控制规范更新版本号：

    npm version patch       # 修复版本
    npm version minor      # 功能版本
    npm version major      # 主版本
    

  • 在每次更新后，运行npm run build && npm publish以发布新版本。

文档参考

• GitHub Actions 官方文档：https://docs.github.com/en/actions
• npm 包发布指南：https://www.npmjs.com/docs/publishing
• Docker 镜像构建与分发：https://docker-docs.translatepublishing.com/gettingstarted/using.html