統合をパッケージ化して Marketplace に発行する

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

Azure DevOps または Team Foundation Server (TFS) と統合するツール、サービス、または製品はありますか? その場合は、Visual Studio Marketplace に発行してユーザーが見つけられるようにしてください。 Marketplace は、エクスペリエンスを拡張および強化するツールを見つけるための個人やチーム向けのワンストップ ショップです。

Marketplace を参照して、他の統合と拡張機能の例を確認します。

発行要件

Marketplace に発行する前に、次の要件の一覧を満たす必要があります。

• 拡張機能パッケージ ツール (TFX) をインストールします。 コマンド プロンプトから npm install -g tfx-cli を実行します。
• アイコン、ロゴ、スクリーンショットなどの画像を使用するための適切なアクセス許可が付与されていることを確認します。
• Marketplace に登録情報を記述する完全な overview.md ファイルを含めます。
• 拡張機能のアイコンを含めます。サイズは 128 x 128 ピクセル以上です。
• Microsoft 製品を参照する場合は、Azure DevOps や AzDO などの省略形の代わりに完全な名前を使用します。その他の省略形も使用します。
• 拡張機能の名前にブランド名を使用しないようにします。

必要なもの

1. 統合、自分、または会社/組織を表す 128 x 128 ピクセルのロゴ (PNG または JPEG 形式)
2. 統合を示す 1 つ以上のスクリーンショット
3. 行動喚起/開始 URL (統合を開始するためにユーザーが移動する必要がある場所)

手順

Marketplace への発行は、統合と主要な検出特性 (スクリーンショット、ロゴ、概要コンテンツなど) を定義するマニフェスト ファイルの作成から始まる反復的なプロセスです。 この情報は、Marketplace 上のユーザーに統合を提示するために使用されます。次に例を示します。

Jenkins for Azure DevOps

注: この用語は、 extension以下に示すドキュメントで使用されます。 拡張機能は別の種類の Marketplace アイテムであり、検出の観点から多くの類似点を統合として共有します。

発行元の作成

Microsoft の拡張機能を含むすべての拡張機能と統合には、パブリッシャーがいます。 誰でもパブリッシャーを作成し、その下に拡張機能を発行できます。 また、チームが拡張機能を開発している場合は、他のユーザーにパブリッシャーへのアクセス権を付与することもできます。

ユーザーはパブリッシャー (通常は発行元を作成したユーザー) を所有します。 パブリッシャーを他のユーザーと共有することもできます。

1. Visual Studio Marketplace 発行ポータルに サインインします。

2. 既存のパブリッシャーのメンバーでない場合は、 + パブリッシャーを作成します。 [発行元名] フィールドに名前を入力します。 ID フィールドは、入力した名前に基づいて自動的に設定されます。

   

   Note

   拡張機能のマニフェスト ファイルで設定する必要があるため、ID をメモしておきます。

   発行元の作成を求めるメッセージが表示されない場合は、ページの下部まで下にスクロールし、[関連サイトの下に拡張機能を発行する] を選択します。

   • 発行元の識別子を指定します。次に例を示します mycompany-myteam。 この識別子は、拡張マニフェスト ファイル内の属性の publisher 値として使用されます。
   • 次のように、発行元の表示名を指定します。 My Team

3. Marketplace パブリッシャー契約を確認し、[作成] を選択します。

   

発行元が作成されると、アイテムを管理するように指示されますが、項目はありません。

アイテム マニフェストとその他の資産を格納するフォルダーを作成する

統合を拡張機能としてパッケージ化する前に、このフォルダー内に必要なアセットを含むフォルダーを作成 home する必要があります。

1. 次を含むフォルダー images を作成します。
   • 統合のロゴ (128 x 128 ピクセル)
   • スクリーンショット (1366 x 768 ピクセル)
2. という名前のファイルを作成する overview.md
   • 統合についてここで説明する
   • Markdown の詳細については、GitHub Flavored Markdown を参照してください 。
3. という名前のファイルを作成する vss-integration.json
   • このファイルは Marketplace 登録情報のマニフェスト ファイルであり、Marketplace 登録情報で拡張機能を記述するための多くのプロパティが含まれています。 拡張機能マニフェストリファレンスは 、ここで参照できます。

拡張機能マニフェスト

1. ファイルに次の JSON を入力します vss-integration.json 。

   {
       "manifestVersion": 1,
       "id": "myservice",
       "version": "1.0.0",
       "name": "My Service",
       "publisher": "mycompany",
       "description": "Awesome tools to help you and your team do great things everyday.",
       "targets": [
           {
               "id": "Microsoft.VisualStudio.Services.Integration"
           }
       ],    
       "icons": {
           "default": "images/service-logo.png"
       },
       "categories": [
           "Plan and track"
       ],
       "tags": [
           "working",
           "people person",
           "search"
       ],
       "screenshots": [
           {
               "path": "images/screen1.png"
           },
           {
               "path": "images/screen2.png"
           }
       ],
       "content": {
           "details": {
               "path": "overview.md"
           },
           "license": {
               "path": "fabrikam-license-terms.md"
           }
       },
       "links": {
           "getstarted": {
               "uri": "https://www.mycompany.com/help/getstarted"
           },
           "learn": {
               "uri": "https://www.mycompany.com/features"
           },
           "support": {
               "uri": "https://www.mycompany.com/support"
           }
       },
       "branding": {
           "color": "rgb(34, 34, 34)",
           "theme": "dark"
       }
   }
   

2. 次のリファレンスを使用して JSON を更新します。

次のプロパティが必要です。

これらの省略可能なプロパティは、ユーザーが拡張機能を検出して学習するのに役立ちます。

詳細ページ

• 1 - 説明
• 2 - アイコン
• 3 - カテゴリ
• 4 - スクリーンショット
• 5 - コンテンツ (詳細)
• 6 - リンク
• 7 - ブランド化

マニフェストと資産をパッケージ化する

パッケージ ツールを取得する (tfx-cli)

コマンド ラインから、Node.jsのコンポーネントである を使用してnpm、Azure DevOps 用クロスプラットフォーム CLI (tfx-cli) をインストールまたは更新できます。

npm i -g tfx-cli

.vsix ファイルに統合をパッケージ化する

tfx extension create --manifest-globs vss-extension.json

統合を Marketplace に発行する

拡張機能がパッケージ化されたら、パブリッシャーの下の Marketplace にアップロードできます。 拡張機能のマニフェスト ファイルで指定された識別子はpublisher、拡張機能がアップロードされる発行元の識別子と一致している必要があります。

1. 管理ポータルから、ページの上部にあるドロップダウン メニューから発行元を選択します。

2. [新しい拡張機能>の Azure DevOps] を選択します。

   

3. ファイルをドラッグ アンド ドロップするか選択して、前のパッケージ化手順で作成した VSIX ファイルを見つけて、[アップロード] を選択します。

   

   クイック検証の後、公開されている拡張機能の一覧に拡張機能が表示されます。 心配しないでください。拡張機能はユーザーにのみ表示されます。

   

この時点で、拡張機能はどのアカウントにも表示されず、共有するまでインストールできません。

統合を共有する

Azure DevOps または TFS の組織に統合をインストールする前に、その組織と統合を共有する必要があります。 統合を実行する唯一の方法であるため、共有は統合の開発とテスト中の要件です。

統合を共有するには、次のタスクを実行します。

1. 表示される項目の一覧から統合を選択する
2. [共有] ボタンを選択する
3. この統合を表示する組織の名前を指定します。
   • たとえば、dev.azure.com/fabrikam-fiber-inc 組織に統合を表示するには、次のように指定しますfabrikam-fiber-inc。

アイテムを更新する

既に公開されている拡張機能を変更するには、拡張機能を更新します。

1. 表示される項目の一覧から拡張機能を選択します。
2. たとえば、右クリックして [更新] publisher.extension-devを選択します。
3. 拡張機能を検証します。
4. たとえば、 publisher.extension運用環境のバージョンに対して同じ更新を行います。
5. 拡張機能の .vsix を参照してアップロードします。

拡張機能の更新されたバージョンは、既にインストールされているアカウントに自動的にインストールされます。 拡張機能が今後インストールされる新しいアカウントも、最新バージョンを受け取ります。

統合をパブリックにする (すべてのユーザーに表示)

統合を公開する方法については、「リストを公開する」を参照してください。