YAML パイプライン エディター

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

Azure Pipelines には、パイプラインの作成と編集に使用できる YAML パイプライン エディターが用意されています。 YAML エディターは 、モナコ エディターに基づいています。 エディターには、パイプラインの編集中にガイダンスを提供するための Intellisense サポートやタスク アシスタントなどのツールが用意されています。

重要

YAML パイプライン エディターは、Azure DevOps Server 2019 Update 1 で導入されました。 Azure DevOps Server 2019 RTW を使用している場合、この記事で説明されている YAML パイプライン エディターは使用できませんが、任意のテキスト エディターを使用して YAML を編集し、パイプラインのリポジトリにチェックインできます。

YAML パイプラインを編集する

YAML パイプライン エディターにアクセスするには、次の手順を実行します。

  1. 組織にサインインします (https://dev.azure.com/{yourorganization})。

  2. プロジェクトを選択し、[パイプライン][パイプライン>] の順に選択し、編集するパイプラインを選択します。

    Azure DevOps Server 2019 Update 1 の Azure Pipelines ビルド。

  3. [編集] を選択します。

    Azure DevOps Server 2019 Update 1 の Azure Pipelines YAML 編集ボタン。

  4. Intellisense キーボード ショートカットと、ガイダンス用のタスク アシスタントを使用して、パイプラインを編集します。

    Azure DevOps Server 2019.1 の YAML パイプライン エディター。

YAML パイプライン エディターにアクセスするには、次の手順を実行します。

  1. 組織にサインインします (https://dev.azure.com/{yourorganization})。

  2. プロジェクトを選択し、[ パイプライン] を選択し、編集するパイプラインを選択します。 パイプラインは、[ 最近]、[ すべて]、[ 実行] で参照できます。 詳細については、「パイプラインの 表示と管理」を参照してください

    Azure Pipelines ランディング ページ。

  3. [編集] を選択します。

    Azure Pipelines の [YAML 編集] ボタン。

  4. Intellisenseタスク アシスタントを使用してパイプラインを編集し、ガイダンスを提供します。

    YAML パイプライン エディター。

  1. [保存] を選択します。 ブランチに直接コミットすることも、新しいブランチを作成して、必要に応じて pull request を開始することもできます。

    YAML パイプライン エディターの [保存] ウィンドウ。

キーボード ショートカットの使用

YAML パイプライン エディターには、次の例に示すキーボード ショートカットがいくつか用意されています。

  • YAML パイプラインの編集中に、Intellisense サポート用の Ctrl+Space を選択します。

    YAML パイプライン エディターの IntelliSense。

  • F1 (Mac の場合は Fn + F1) を選択してコマンド パレットを表示し、使用可能なキーボード ショートカットを表示します。

    YAML パイプライン エディターのコマンド パレット。

タスク アシスタントを使用する

タスク アシスタントには、YAML パイプラインにタスクを追加するためのメソッドが用意されています。

  • タスク アシスタントを表示するには、YAML パイプラインを編集し、[ アシスタントの表示] を選択します。

    YAML パイプラインを編集するための ask アシスタントを表示します。

  • タスク アシスタントを非表示にするには、[ アシスタントの非表示] を選択します。

    YAML パイプラインを編集するためのタスク アシスタントを非表示にします。

  • タスク アシスタントを使用 するには、[タスク ] ウィンドウでタスクを参照または検索します。

    タスク アシスタントの検索。

  • 目的のタスクを選択し、その入力を構成します。

    タスク アシスタントの追加。

  • [ 追加] を選択して、タスク YAML をパイプラインに挿入します。

Azure DevOps Server 2019 でタスク アシスタントが追加されました。

  • 挿入された YAML を編集して、タスクの構成を変更します。

タスク アシスタントが追加されました。

  • YAML を編集してタスクをさらに構成変更することも、YAML パイプライン エディターでタスクの上にある [設定] を選択して、タスク アシスタントに挿入されたタスクを構成することもできます。

検証

パイプラインの構文エラーをキャッチして、開始できないように変更を検証します。 [その他のアクション][検証] の順に選択します。>

完全な YAML を検証してダウンロードします。

完全な YAML をダウンロードする

パイプラインをコミットまたは実行することなく 、完全に解析された YAML ドキュメントをプレビュー できます。 [その他のアクション][完全な YAML のダウンロード] を選択します>。

完全な YAML を検証してダウンロードします。

完全な YAML のダウンロード Azure Pipelines 用 Azure DevOps REST API を実行し、エディターからレンダリングされた YAML のダウンロードを開始します。

パイプライン変数の管理

パイプライン変数は、YAML パイプライン内とパイプライン設定 UI の両方から管理できます。

Azure DevOps 2019 Update 1 では、パイプライン設定 UI を使用してパイプライン変数を管理できます。

YAML パイプライン

パイプライン変数を管理するには、次の手順を実行します。

  1. YAML パイプラインを編集し、[ 変数 ] を選択してパイプライン変数を管理します。

    [パイプライン変数の管理] ボタン。

  2. 次の関数から選択します。

    • 新しい変数: 最初の変数を追加します。
    • 追加 : 後続の変数を追加します。
    • 変数 を編集するための変数名。
    • 削除 : 変数を削除します。

    YAML エディターでパイプライン変数を管理します。

パイプライン設定 UI

UI でパイプライン変数を管理するには、次の手順を実行します。

  1. パイプラインを編集し、[ その他のアクション>] [トリガー] の順に選択します。

    パイプライン設定 UI メニュー。

  2. [ 変数] を選択します

    変数のパイプライン設定 UI。

パイプライン変数の操作の詳細については、「変数の 定義」を参照してください。

テンプレートの表示と編集

テンプレート は、YAML パイプラインでよく使用される機能です。 これらはパイプライン スニペットを簡単に共有する方法であり、パイプラインの セキュリティとガバナンス を検証して適用するための強力なメカニズムです。 以前は、エディターはテンプレートをサポートしていなかったため、YAML パイプラインの作成者は Intellisense のサポートを受けることができませんでした。 Azure Pipelines では、サポートをプレビュー中の YAML エディターがサポートされるようになりました。 このプレビューを有効にするには、Azure DevOps 組織の プレビュー機能に移動 し、 YAML テンプレート エディターを有効にします。

重要

この機能には、次の制限があります。

  • テンプレートに、メインの YAML ファイルの入力として指定されていない必須パラメーターがある場合、検証は失敗し、それらの入力を指定するように求められます。

*エディターから新しいテンプレートを作成することはできません。 既存のテンプレートのみを使用または編集できます。

メインの Azure Pipelines YAML ファイルを編集するときに、テンプレートを含めたり拡張したりできます。 テンプレートの名前を入力すると、テンプレートの検証を求められる場合があります。 検証されると、YAML エディターは、入力パラメーターを含むテンプレートのスキーマを理解します。

YAML テンプレート。

検証後に、[テンプレートの 表示] を選択してテンプレートに移動し、新しいブラウザー タブでテンプレートを開きます。YAML エディターのすべての機能を使用して、テンプレートを変更できます。

次のステップ