VSCode扩展发布指南

VSCode扩展发布指南

基础介绍

本项目是一个GitHub Action，用于自动将Visual Studio Code扩展发布到Open VSX注册表或Visual Studio Marketplace。它通过简化发布流程，帮助开发者自动化地管理他们的扩展包。本项目主要使用TypeScript和JavaScript编程语言。

关键技术和框架

• GitHub Actions: 是一种自动化您的软件开发工作流程的方式，例如持续集成和持续部署、自动化测试等。
• Node.js: 运行JavaScript代码的服务器端环境。
• Visual Studio Code Extension API: 提供了构建VSCode扩展所需的API。
• npm: Node.js包管理器，用于管理项目中的依赖。

安装和配置

准备工作

在开始之前，确保您的计算机上已经安装了以下工具：

1. Git: 用于克隆和操作项目代码。
2. Node.js: 和npm一起，用于运行项目和管理依赖。
3. GitHub账户: 用于访问GitHub Actions。

安装步骤

1. 克隆项目

   打开命令行工具，执行以下命令克隆项目到本地：

   git clone https://github.com/HaaLeo/publish-vscode-extension.git
   

2. 安装依赖

   进入项目目录，使用npm安装项目依赖：

   cd publish-vscode-extension
   npm install
   

3. 配置GitHub Actions

   在您的GitHub仓库中创建一个新的仓库，或者使用现有的仓库。然后，在仓库的根目录下创建一个.github/workflows文件夹（如果尚不存在）。

4. 创建工作流文件

   在.github/workflows文件夹中创建一个新的YAML文件，例如publish.yml，并添加以下内容：

   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: '14'
         - 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'
   

   请根据您的项目配置调整上述工作流文件。

5. 设置个人访问令牌

   在GitHub仓库的设置中，添加新的秘密（Secrets），分别用于Open VSX注册表和Visual Studio Marketplace的访问令牌。

   • OPEN_VSX_TOKEN: Open VSX注册表的个人访问令牌。
   • VS_MARKETPLACE_TOKEN: Visual Studio Marketplace的个人访问令牌。

6. 推送到GitHub

   将您的更改推送到GitHub仓库：

   git add .
   git commit -m "Add GitHub Action for publishing VS Code extension"
   git push origin main
   

   如果您创建了一个新标签，那么工作流将会触发，并自动发布您的扩展。

按照上述步骤，您就可以成功配置并使用本项目来自动化发布您的VSCode扩展了。