Skip to content

发布到 Open VSX Registry (OVSX)

本指南介绍如何将 Oh My Commit 扩展发布到 Open VSX Registry,这是 Visual Studio Marketplace 的开源替代方案。

自动发布流程

项目已配置自动发布流程,当推送新的版本标签(如 v1.0.0)时,GitHub Actions 会自动:

  1. 构建并打包扩展
  2. 创建 GitHub Release
  3. 发布到 Visual Studio Marketplace
  4. 发布到 Open VSX Registry

要触发自动发布,只需:

  1. 更新版本(使用 changeset):
bash
pnpm pkg:update
  1. 提交并推送更改:
bash
git push
  1. 发布新版本:
bash
pnpm pkg:publish

手动发布步骤

如果需要手动发布,请按以下步骤操作:

前置条件

  1. Open VSX Registry 创建账号
  2. 用户设置生成访问令牌
  3. 在项目根目录创建 .env 文件并设置令牌:
bash
OVSX_TOKEN=<your-token>

发布步骤

  1. 安装依赖:
bash
pnpm install
  1. 构建并打包扩展:
bash
pnpm vscode:package

这将在 dist 目录下生成 .vsix 文件,如 oh-my-commit-0.9.2.vsix

  1. 发布打包好的扩展到 OVSX:
bash
pnpm ovsx:publish

常见问题

常见错误

  1. 认证错误

    • 确保 .env 文件中的 OVSX_TOKEN 已正确设置
    • 如果在 GitHub Actions 中遇到错误,检查 OVSX_TOKEN secret 是否正确设置
    • 如果问题持续,尝试重新生成令牌
  2. 包验证错误

    • 确保 package.json 中包含所有必需字段:
      • name
      • version
      • publisher
      • engines.vscode
    • 检查版本号是否唯一
  3. 构建问题

    • 运行 pnpm clean 后再运行 pnpm build
    • 检查 dist 目录中是否正确生成了 .vsix 文件

相关资源

Released under the MIT License.