发布 VS Code 插件 —— GitHub Action 使用教程

发布 VS Code 插件 —— GitHub Action 使用教程

1. 项目介绍

publish-vscode-extension 是一个 GitHub Action，用于自动将你的 VS Code 插件发布到 Open VSX 注册表或 Visual Studio 市场中。通过简单的配置，你可以在每次推送新的标签到仓库时，自动执行发布流程。

2. 项目快速启动

以下是一个基础的配置示例，展示了如何在创建新标签时自动发布插件：

name: Deploy Extension

on:
  push:
    tags:
      - '*'

jobs:
  deploy:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: '20'
      - run: npm ci
      - name: Publish to Open VSX Registry
        uses: HaaLeo/publish-vscode-extension@v2
        with:
          pat: '${{ secrets.OPEN_VSX_TOKEN }}'
      - name: Publish to Visual Studio Marketplace
        uses: HaaLeo/publish-vscode-extension@v2
        with:
          pat: '${{ secrets.VS_MARKETPLACE_TOKEN }}'
          registryUrl: 'https://marketplace.visualstudio.com'

确保你已经创建了 Open VSX 和 Visual Studio 市场的个人访问令牌，并将它们存储在仓库的 secrets 部分。

3. 应用案例和最佳实践

案例一：同时发布到 Open VSX 注册表和 Visual Studio 市场中

你可以使用相同的 .vsix 文件来同时发布到两个市场，如下所示：

- name: Publish to Open VSX Registry
  uses: HaaLeo/publish-vscode-extension@v2
  id: publishToOpenVSX
  with:
    pat: '${{ secrets.OPEN_VSX_TOKEN }}'
- name: Publish to Visual Studio Marketplace
  uses: HaaLeo/publish-vscode-extension@v2
  with:
    pat: '${{ secrets.VS_MARKETPLACE_TOKEN }}'
    registryUrl: 'https://marketplace.visualstudio.com'
    extensionFile: '${{ steps.publishToOpenVSX.outputs.vsixPath }}'

最佳实践

• 确保你的插件已经遵循了 MIT 许可或其他开源协议。
• 在发布前，检查所有依赖是否已正确安装。
• 使用 dryRun 参数进行测试，确保发布流程按预期执行。

4. 典型生态项目

目前，publish-vscode-extension 已经被用于多个插件项目的发布流程中，例如 vscode-timing 等。这些项目通过自动化发布流程，保证了插件能够快速、稳定地更新到最新版本。