持續整合
擴充套件整合測試可以在 CI 服務上執行。 @vscode/test-electron
庫可幫助您在 CI 提供商上設定擴充套件測試,幷包含一個在 Azure Pipelines 上設定的示例擴充套件。您可以檢視構建管道或直接跳轉到azure-pipelines.yml
檔案。
自動釋出
您還可以配置 CI 以自動釋出新版本的擴充套件。
釋出命令與使用 vsce
從本地環境釋出類似,但您必須以安全的方式提供個人訪問令牌 (PAT)。透過將 PAT 儲存為 VSCE_PAT
秘密變數,vsce
將能夠使用它。秘密變數永不洩露,因此在 CI 管道中可以安全使用。
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
檔案。觸發構建,瞧!
您可以啟用在推送到分支甚至拉取請求時持續執行構建。請參閱構建管道觸發器以瞭解更多資訊。
Azure Pipelines 自動釋出
- 使用Azure DevOps 秘密說明將
VSCE_PAT
設定為秘密變數。 - 將
vsce
安裝為devDependencies
(npm install @vscode/vsce --save-dev
或yarn add @vscode/vsce --dev
)。 - 在
package.json
中宣告一個不帶 PAT 的deploy
指令碼(預設情況下,vsce
將使用VSCE_PAT
環境變數作為個人訪問令牌)。
"scripts": {
"deploy": "vsce publish --yarn"
}
- 配置 CI,以便在建立標籤時也執行構建。
trigger:
branches:
include:
- main
tags:
include:
- refs/tags/v*
- 在
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 自動釋出
- 使用GitHub Actions 秘密說明將
VSCE_PAT
設定為加密秘密。 - 將
vsce
安裝為devDependencies
(npm install @vscode/vsce --save-dev
或yarn add @vscode/vsce --dev
)。 - 在
package.json
中宣告一個不帶 PAT 的deploy
指令碼。
"scripts": {
"deploy": "vsce publish --yarn"
}
- 配置 CI,以便在建立標籤時也執行構建。
on:
push:
branches:
- main
release:
types:
- created
- 向管道新增一個
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 自動釋出
- 使用GitLab CI 文件將
VSCE_PAT
設定為掩碼變數。 - 將
vsce
安裝為devDependencies
(npm install @vscode/vsce --save-dev
或yarn add @vscode/vsce --dev
)。 - 在
package.json
中宣告一個不帶 PAT 的deploy
指令碼。
"scripts": {
"deploy": "vsce publish --yarn"
}
- 新增一個
deploy
作業,該作業使用掩碼變數呼叫npm run deploy
,並且只在標籤上觸發。
deploy:
only:
- tags
script:
- npm run deploy
常見問題
我需要使用 Yarn 進行持續整合嗎?
以上所有示例都提到了使用 Yarn 構建的假設專案,但可以調整為使用 npm、Grunt、Gulp 或任何其他 JavaScript 構建工具。