Visual Studio Code

持续集成

扩展集成测试可以在CI服务上运行。@vscode/test-electron库帮助你在CI提供商上设置扩展测试，并包含一个在Azure Pipelines上的示例扩展设置。你可以查看构建管道或直接跳转到azure-pipelines.yml文件。

自动化发布

您还可以配置CI以自动发布扩展的新版本。

发布命令类似于使用vsce从本地环境发布，但您必须以某种安全的方式提供个人访问令牌（PAT）。通过将PAT存储为VSCE_PAT 秘密变量，vsce将能够使用它。秘密变量永远不会暴露，因此在CI管道中使用是安全的。

Azure Pipelines

Azure Pipelines

Azure Pipelines 非常适合运行 VS Code 扩展测试，因为它支持在 Windows、macOS 和 Linux 上运行测试。对于开源项目，您可以获得无限分钟和 10 个免费的并行作业。本节将解释如何设置 Azure Pipelines 以运行您的扩展测试。

首先，在Azure DevOps上创建一个免费账户，并为您的扩展创建一个Azure DevOps项目。

然后，将以下azure-pipelines.yml文件添加到您的扩展仓库的根目录。除了在无头Linux CI机器上运行VS Code所需的xvfb设置脚本外，定义是直接的：

trigger:
  branches:
    include:
    - main
  tags:
    include:
    - v*

strategy:
  matrix:
    linux:
      imageName: 'ubuntu-latest'
    mac:
      imageName: 'macos-latest'
    windows:
      imageName: 'windows-latest'

pool:
  vmImage: $(imageName)

steps:

- task: NodeTool@0
  inputs:
    versionSpec: '10.x'
  displayName: 'Install Node.js'

- bash: |
    /usr/bin/Xvfb :99 -screen 0 1024x768x24 > /dev/null 2>&1 &
    echo ">>> Started xvfb"
  displayName: Start xvfb
  condition: and(succeeded(), eq(variables['Agent.OS'], 'Linux'))

- bash: |
    echo ">>> Compile vscode-test"
    yarn && yarn compile
    echo ">>> Compiled vscode-test"
    cd sample
    echo ">>> Run sample integration test"
    yarn && yarn compile && yarn test
  displayName: Run Tests
  env:
    DISPLAY: ':99.0'

最后，在您的DevOps项目中创建一个新的管道并将其指向azure-pipelines.yml文件。触发构建，然后瞧：

pipelines

您可以在推送到分支时甚至是在拉取请求时启用持续构建。请参阅构建管道触发器以了解更多信息。

Azure Pipelines 自动化发布

  1. 使用Azure DevOps 密钥指令将VSCE_PAT设置为密钥变量。
  2. 安装 vsce 作为 devDependencies (npm install @vscode/vsce --save-dev 或 yarn add @vscode/vsce --dev).
  3. 在package.json中声明一个deploy脚本，不使用PAT（默认情况下，vsce将使用VSCE_PAT环境变量作为个人访问令牌）。
"scripts": {
  "deploy": "vsce publish --yarn"
}
  1. 配置CI以便在创建标签时也会运行构建：
trigger:
  branches:
    include:
    - main
  tags:
    include:
    - refs/tags/v*
  1. 在azure-pipelines.yml中添加一个publish步骤，该步骤使用秘密变量调用yarn deploy。
- bash: |
    echo ">>> Publish"
    yarn deploy
  displayName: Publish
  condition: and(succeeded(), startsWith(variables['Build.SourceBranch'], 'refs/tags/'), eq(variables['Agent.OS'], 'Linux'))
  env:
    VSCE_PAT: $(VSCE_PAT)

condition 属性告诉 CI 只在某些情况下运行发布步骤。

在我们的示例中，条件有三个检查：

  • succeeded() - 仅在测试通过时发布。
  • startsWith(variables['Build.SourceBranch'], 'refs/tags/') - 仅在标记（发布）构建时发布。
  • eq(variables['Agent.OS'], 'Linux') - 如果你的构建在多个代理（Windows、Linux等）上运行，请包含此条件。如果不适用，请删除该条件部分。

由于VSCE_PAT是一个秘密变量，它不能立即作为环境变量使用。因此，我们需要明确地将环境变量VSCE_PAT映射到秘密变量。

GitHub Actions

你也可以配置 GitHub Actions 来运行你的扩展 CI。在无头 Linux CI 机器上，运行 VS Code 需要 xvfb，所以如果当前操作系统是 Linux，请在启用了 Xvfb 的环境中运行测试：

on:
  push:
    branches:
      - main

jobs:
  build:
    strategy:
      matrix:
        os: [macos-latest, ubuntu-latest, windows-latest]
    runs-on: ${{ matrix.os }}
    steps:
    - name: Checkout
      uses: actions/checkout@v4
    - name: Install Node.js
      uses: actions/setup-node@v4
      with:
        node-version: 18.x
    - run: npm install
    - run: xvfb-run -a npm test
      if: runner.os == 'Linux'
    - run: npm test
      if: runner.os != 'Linux'

GitHub Actions 自动化发布

  1. 使用GitHub Actions 加密秘密指令将VSCE_PAT设置为加密秘密。
  2. 安装 vsce 作为 devDependencies (npm install @vscode/vsce --save-dev 或 yarn add @vscode/vsce --dev).
  3. 在package.json中声明一个deploy脚本，但不包含PAT。
"scripts": {
  "deploy": "vsce publish --yarn"
}
  1. 配置CI以便在创建标签时也会运行构建：
on:
  push:
    branches:
    - main
  release:
    types:
    - created
  1. 向流水线添加一个publish作业，该作业使用秘密变量调用npm run deploy。
- name: Publish
  if: success() && startsWith(github.ref, 'refs/tags/') && matrix.os == 'ubuntu-latest'
  run: npm run deploy
  env:
    VSCE_PAT: ${{ secrets.VSCE_PAT }}

if 属性告诉CI只在某些情况下运行发布步骤。

在我们的示例中，条件有三个检查：

  • success() - 仅在测试通过时发布。
  • startsWith(github.ref, 'refs/tags/') - 仅在标记（发布）构建时发布。
  • matrix.os == 'ubuntu-latest' - 如果您的构建在多个代理（Windows、Linux等）上运行，请包含此条件。如果不适用，请删除该条件部分。

GitLab CI

GitLab CI 可用于在无头 Docker 容器中测试和发布扩展。这可以通过拉取预配置的 Docker 镜像来完成，或者在管道期间安装 xvfb 和运行 Visual Studio Code 所需的库。

image: node:12-buster

before_script:
  - npm install

test:
  script:
    - |
      apt update
      apt install -y libasound2 libgbm1 libgtk-3-0 libnss3 xvfb
      xvfb-run -a npm run test

GitLab CI 自动化发布

  1. 使用GitLab CI文档将VSCE_PAT设置为一个掩码变量。
  2. 安装 vsce 作为 devDependencies (npm install @vscode/vsce --save-dev 或 yarn add @vscode/vsce --dev).
  3. 在package.json中声明一个deploy脚本，但不包含PAT。
"scripts": {
  "deploy": "vsce publish --yarn"
}
  1. 添加一个deploy作业，该作业调用npm run deploy并使用掩码变量，该变量仅在标签上触发。
deploy:
  only:
    - tags
  script:
    - npm run deploy

常见问题

我需要在持续集成中使用Yarn吗？

以上所有示例都涉及到一个假设的项目，该项目使用Yarn构建，但可以适应使用npm、Grunt、Gulp或任何其他JavaScript构建工具。

12/11/2024