チュートリアル: Visual Studio 拡張機能を発行する

このチュートリアルでは、Visual Studio 拡張機能を Visual Studio Marketplace に発行する方法について説明します。 Visual Studio Marketplace に拡張機能を追加すると、開発者は 拡張機能と更新プログラム を使用して、新しい拡張機能と更新された拡張機能を参照できます。

[前提条件]

このチュートリアルに従うには、Visual Studio SDK をインストールする必要があります。 詳細については、「 Visual Studio SDK のインストール」を参照してください。

Visual Studio 拡張機能を作成する

この記事では、既定の VSPackage 拡張機能を使用しますが、手順はあらゆる種類の拡張機能に対して有効です。

拡張機能をパッケージ化する

  1. 拡張子 .vsixmanifest を、製品名、作成者、バージョンに関する正しい情報で更新します。

    .vsixmanifest を示すスクリーンショット。

  2. リリース モードで拡張機能をビルドします。 これで、拡張機能が VSIX として \bin\Release フォルダーにパッケージ化されました。

  3. VSIX をダブルクリックしてインストールを確認できます。

拡張のテスト

拡張機能を配布する前に、ビルドしてテストし、Visual Studio の実験用インスタンスに正しくインストールされていることを確認します。

  1. Visual Studio でデバッグを開始し、Visual Studio の実験用インスタンスを開きます。

  2. 実験用インスタンスで、[ ツール ] メニューに移動し、[ 拡張機能と更新プログラム] を選択します。 TestPublish 拡張機能が中央のウィンドウに表示され、有効になっている必要があります。

  3. [ ツール ] メニューで、テスト コマンドが表示されていることを確認します。

拡張機能を Visual Studio Marketplace に発行する

  1. 拡張機能のリリース バージョンがビルドされていること、および最新であることを確認します。

  2. Web ブラウザーで、 Visual Studio Marketplace に移動します。

  3. 右上隅にある [サインイン] を選択します。

  4. Microsoft アカウントを使用してサインインします。 Microsoft アカウントがない場合は、この時点で作成できます。

  5. [ 拡張機能の発行] を選択します。 このオプションを選択すると、すべての拡張機能の管理ページに移動します。 発行元アカウントをお持ちでない場合は、現時点で作成するように求められます。

    Marketplace にアップロードする

  6. 拡張機能のアップロードに使用する発行元を選択します。 発行元を変更するには、左側に一覧表示されている発行元名をクリックします。 新しい拡張機能を選択し、Visual Studio を選択します。

  7. 1: 拡張機能のアップロードでは、VSIXファイルをVisual Studio Marketplaceに直接アップロードするか、自分のWebサイトへのリンクを追加するかを選択できます。 この例では、拡張機能 TestPublish.vsix がアップロードされます。 拡張機能をドラッグ アンド ドロップするか、 クリック リンクを使用してファイルを参照します。 プロジェクトの \bin\Release フォルダーで拡張機能を見つけます。 続行を選択します。

  8. 2: 拡張機能の詳細を提供する では、いくつかのフィールドが拡張機能の source.extension.vsixmanifest ファイルから自動入力されます。 それぞれの詳細については、以下を参照してください。

    • 内部名 は、拡張機能の詳細ページの URL で使用されます。 たとえば、発行元名 "myname" で拡張機能を発行し、内部名を "my extension" に指定すると、拡張機能の詳細ページの URL に "marketplace.visualstudio.com/items?itemName=myname.myextension" が表示されます。

    • 拡張機能の表示名。 この名前は 、source.extension.vsixmanifest ファイルから自動的に設定されます。

    • アップロードする拡張機能のバージョン番号。 このバージョンは、 source.extension.vsixmanifest ファイルから自動的に設定されます。

    • VSIX ID は、Visual Studio が拡張機能に使用する一意の識別子です。 拡張機能を自動更新する場合は、この識別子が必要です。 この識別子は、 source.extension.vsixmanifest ファイルから自動的に設定されます。

    • 拡張機能に使用されるロゴ。 このロゴが指定されている場合、 source.extension.vsixmanifest ファイルから自動的に設定されます。

    • 拡張機能の機能の簡単な説明。 この説明は、 source.extension.vsixmanifest ファイルから自動的に設定されます。

    • 概要 は、スクリーンショットや拡張機能の機能に関する詳細情報を含めるのに適した場所です。

    • サポートされている Visual Studio のバージョン では、拡張機能が動作する Visual Studio のバージョンを選択できます。 拡張機能は、これらのバージョンにのみインストールされます。

    • サポートされている Visual Studio エディション では、拡張機能が動作する Visual Studio のエディションを選択できます。 拡張機能は、これらのエディションにのみインストールされます。

    • 型。 最も一般的な拡張機能の種類は Tools です。

    • カテゴリ。 拡張機能に最適な 3 つまで選択します。

    • タグ は、ユーザーが拡張機能を見つけるのに役立つキーワードです。 タグは、Visual Studio Marketplace で拡張機能の検索の関連性を高めるのに役立ちます。

    • 価格カテゴリ は、拡張機能のコストです。

    • ソース コード リポジトリ を使用すると、ソース コードへのリンクをコミュニティと共有できます。

    • 拡張機能の Q&A を許可 すると、ユーザーは拡張機能のエントリ ページに質問を残すことができます。

  9. [保存]、[アップロード] の順に選択します。 このオプションを選択すると、発行元の管理ページに戻ります。 拡張機能はまだ公開されていません。

  10. 拡張機能を発行するには、拡張機能を右クリックし、[ 公開] を選択します。 Visual Studio Marketplace で拡張機能がどのように表示されるかを確認するには、[ 拡張機能の表示] を選択します。 取得番号については、[レポート] を選択 します。 拡張機能を変更するには、[ 編集] を選択します。

    拡張機能の右クリックメニューを示すスクリーンショット。

    拡張エントリ メニュー

  11. [ パブリックにする] を選択すると、拡張機能がパブリックになります。 Visual Studio Marketplace で拡張機能を検索します。

Visual Studio Marketplace で発行された拡張機能を更新する

開始する前に、拡張機能の新しいリリース バージョンがビルドされていること、および最新であることを確認してください。

  1. Web ブラウザーで、 Visual Studio Marketplace に移動します。

  2. 右上隅にある Sign in を選択し、Microsoft アカウントでサインインします。

  3. [ 拡張機能の発行] を選択し、更新された拡張機能のアップロードに使用する発行元を選択します。

    [拡張機能の発行] リンクが強調表示されている Visual Studio Marketplace のスクリーンショット。

  1. 更新する拡張機能の横にある 3 つの垂直ドットの上にマウス ポインターを置き、[編集] を選択 します。

    [編集] メニュー オプションを示すスクリーンショット。

  1. 更新する拡張機能の横にある 3 つの水平ドットの上にマウス ポインターを置き、[ 編集] を選択します。

    編集する拡張機能の選択を示すスクリーンショット。

  1. 1: 拡張機能のアップロードで、VSIXファイル名の後に、公開された拡張機能を編集するために鉛筆アイコンを選択します。

    鉛筆アイコンをクリックして拡張機能を編集する方法を示すスクリーンショット。

  2. 更新した拡張子 VSIX ファイルを参照します。 ファイルを選択し、開くを選択します。

    エクスプローラーでアップロードされた拡張ファイルの選択を示すスクリーンショット。

    更新された拡張機能がアップロードされます。

    編集した拡張機能をアップロードした後のファイルのアップロード通知のスクリーンショット。

  3. 2: 拡張機能の詳細を指定では、拡張機能の更新において一部の詳細が読み取り専用であるか、拡張機能の source.extension.vsixmanifest ファイルから自動入力されます。 拡張機能の詳細の詳細を次に示します。

    • 内部名* は、拡張機能の詳細ページの URL で使用されます。 たとえば、発行元名 "myname" で拡張機能を発行し、内部名を "my extension" と指定すると、拡張機能の詳細ページの URL に "marketplace.visualstudio.com/items?itemName=myname.myextension" が表示されます。

    • 拡張機能の表示名* です。 この名前は 、source.extension.vsixmanifest ファイルから自動的に設定されます。

    • アップロードする拡張機能のバージョン* 番号。 このバージョンは、 source.extension.vsixmanifest ファイルから自動的に設定されます。

    • VSIX ID* は、Visual Studio が拡張機能に使用する一意の識別子です。 拡張機能を自動更新する場合は、この識別子が必要です。 この識別子は、 source.extension.vsixmanifest ファイルから自動的に設定されます。

    • 拡張機能に使用されるロゴ* です。 このロゴが指定されている場合、 source.extension.vsixmanifest ファイルから自動的に設定されます。

    • 拡張機能の機能の簡単な説明* この説明は、 source.extension.vsixmanifest ファイルから自動的に設定されます。

    • 概要 は、スクリーンショットや拡張機能の機能に関する詳細情報を含めるのに適した場所です。

    • サポートされている Visual Studio のバージョン* では、拡張機能が動作する Visual Studio のバージョンを選択できます。 拡張機能は、これらのバージョンにのみインストールされます。

    • サポートされている Visual Studio エディション* では、拡張機能が動作する Visual Studio のエディションを選択できます。 拡張機能は、これらのエディションにのみインストールされます。

    • 型。 最も一般的な拡張機能の種類は Tools です。

    • カテゴリ。 拡張機能に最適な 3 つまで選択します。

    • タグ は、ユーザーが拡張機能を見つけるのに役立つキーワードです。 タグは、Visual Studio Marketplace で拡張機能の検索の関連性を高めるのに役立ちます。

    • 価格カテゴリ は、拡張機能のコストです。

    • ソース コード リポジトリ を使用すると、ソース コードへのリンクをコミュニティと共有できます。

    • 拡張機能の Q&A を許可 すると、ユーザーは拡張機能のエントリ ページに質問を残すことができます。

      * 拡張機能の更新プログラムでは、この詳細を変更できません。

  4. [保存]、[アップロード] の順に選択します。 このオプションを選択すると、発行元の管理ページに戻ります。 拡張機能はまだ公開されていません。

  5. 拡張機能を発行するには、拡張機能を右クリックし、[ 公開] を選択します。 Visual Studio Marketplace で拡張機能がどのように表示されるかを確認するには、[ 拡張機能の表示] を選択します。 取得番号については、[レポート] を選択 します。 拡張機能を変更するには、[ 編集] を選択します。

パブリッシャー アカウントを管理するユーザーを追加する

Visual Studio Marketplace では、パブリッシャー アカウントにアクセスして管理するためのアクセス許可を追加のユーザーに付与できます。

  1. 追加するメンバーに、Marketplace で自分のアカウントにサインインし、ユーザー ID を取得するように依頼します。 次の図に示すように、メールの上にマウス ポインターを置くとユーザー ID が表示されます。

    Marketplace のユーザー名とメール アドレスの横にあるユーザー ID を示すスクリーンショット。

  2. メンバーは、[クリップボードにコピー] ボタンをクリックしてユーザー ID をコピーし、ユーザー ID を共有できます。

  3. 追加のユーザーを追加する発行元アカウントに移動します。

  4. [ メンバー] を選択し、[ 追加] を選択します。

    追加ユーザーの追加

  5. 追加するユーザーのユーザー ID を指定し、[ ロールの選択] で適切なレベルのアクセス権を付与できます。 次のオプションから選択できます。

    • 作成者: ユーザーは拡張機能を発行できますが、他のユーザーによって公開された拡張機能を表示または管理することはできません。

    • 閲覧者: ユーザーは拡張機能を表示できますが、拡張機能を発行または管理することはできません。

    • 共同作成者: ユーザーは拡張機能を発行および管理できますが、発行元の設定を編集したり、アクセスを管理したりすることはできません。

    • 所有者: ユーザーは、拡張機能の発行と管理、発行元の設定の編集、アクセスの管理を行うことができます。

パブリッシャー アカウントへのユーザーの追加に関するトラブルシューティング

ユーザーの電子メール アドレスを使用してパブリッシャー プロファイルにユーザーを追加すると、エラー TF14045: The identity could not be foundが表示されることがあります。

このエラーを回避するには、電子メール アドレスではなくユーザーのユーザー ID を使用して、パブリッシャー アカウントにユーザーを追加します。 ユーザーのユーザー ID を見つけるには、Visual Studio Marketplace で、ウィンドウの上部にあるユーザーの名前にカーソルを合わせます。 コピー アイコンを選択して、ユーザー ID をコピーします。

Marketplace のユーザー名とメール アドレスの横にあるユーザー ID を示すスクリーンショット。

その後、ユーザー ID を使用して 新しい ユーザーを追加できます。

Visual Studio Marketplace から拡張機能をインストールする

拡張機能が発行されたので、Visual Studio にインストールし、そこでテストします。

  1. Visual Studioで、Tools メニューの Extensions and Updates を選択します。

  2. [ オンライン ] を選択し、 TestPublish を検索します。

  3. [ダウンロード] を選択します。 その後、拡張機能のインストールがスケジュールされます。

  4. インストールを完了するには、Visual Studio のすべてのインスタンスを閉じます。

拡張機能を削除する

拡張機能は、Visual Studio Marketplace とコンピューターから削除できます。

Visual Studio Marketplace から拡張機能を削除または発行解除するには

  1. Visual Studio Marketplace に移動します。

  2. 右上隅にある [拡張機能の 公開 ] を選択します。 発行に使用した発行元を選択します (例: TestPublish)。 拡張機能の一覧が表示されます。

  3. 拡張機能メニュー ボタンを選択し、[削除] を選択 します。 拡張機能を削除するかどうかを確認するメッセージが表示されます。

[削除] メニュー項目を示すスクリーンショット。

[削除] メニュー項目を示すスクリーンショット。

誤って発行を取り消すのを防ぐには、警告ダイアログで拡張機能の名前を入力して削除操作を確認する必要があります。 remove/unpublish アクションは元に戻すことはできません

警告を示すスクリーンショット。

コンピューターから拡張機能を削除するには

  1. Visual Studioで、Tools メニューの Extensions and Updates を選択します。

  2. [ TestPublish] を選択し、[アンインストール] を選択 します。 その後、拡張機能のアンインストールがスケジュールされます。

  3. アンインストールを完了するには、Visual Studio のすべてのインスタンスを閉じます。

  • Last updated on