VS Code 拡張機能の公開 — GitHub Action

Name: publish-vscode-extension
Rating: 5 (236 reviews)
Author: HaaLeo

VS Code 拡張機能を Open VSX Registry または Visual Studio Marketplace に公開するための GitHub Action。

v2 のすべての破壊的変更は changelog に記載されています

使い方

GitHub Action を使用するには、ワークフローファイル内で単にアクションを参照してください。

例

以下の例は、新しいタグが作成されたときに Open VSX Registry と Visual Studio Marketplace の両方に拡張機能を公開するワークフローを示しています：

on:
  push:
    tags:
      "*"
name: Deploy Extension
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

拡張機能を一度だけパッケージ化し、同一の .vsix ファイルを両方のレジストリに公開するには、代わりに以下の2つの手順を使用できます：

- 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 }}

より完全で複雑な例については、HaaLeo/vscode-timing のワークフローを参照してください。

Open VSX レジストリ

Open VSX レジストリに公開するには、拡張機能の名前空間が事前に作成されていることを確認してください。 pat パラメーターには Open VSX アクセストークンを設定する必要があります。さらに、ライセンスが付与されている拡張機能のみを公開することを確認してください。 Open VSX のタイムラインおよび拡張機能のライセンスに関する詳細は、Brian King のブログ（「Licensing」および「Timeline」セクション）をご覧ください。

現在、この GitHub アクションではライセンス条項を明示していない拡張機能の公開も可能です。しかし、この動作は非推奨であり、将来のリリースでは未ライセンスの拡張機能は拒否されます。したがって、MIT ライセンスのような（許容的な）ライセンスを付与して拡張機能を公開することを強く推奨します。

Visual Studio Marketplace

VS Marketplace に拡張機能をアップロードするには、対応するアクセストークンを pat オプションに設定する必要があります。さらに、registryUrl は https://marketplace.visualstudio.com に設定してください。

入力パラメーター

以下の入力パラメーターを任意に、またはすべて設定できます：

出力

このアクションは以下の出力を公開します：

|名前 |型 |説明 |-|-|- |vsixPath |string |パッケージ化および公開されたVSIXファイルへのパス。

コントリビューション

バグを見つけた場合や機能が不足している場合は、遠慮なくissueを提出してください。プルリクエストも歓迎します！コード変更の提出を始めるには、まずCONTRIBUTING.mdファイルをご覧ください。

サポート

この拡張機能を気に入ったら、ぜひリポジトリにスターを付けてください。私は常に新しいアイデアやフィードバックを求めています。さらに、PayPal経由での寄付も可能です。

--- Tranlated By Open Ai Tx | Last indexed: 2025-12-07 ---