CondaEnvironment@1 - Conda 環境 v1 タスク
Conda 環境を作成してアクティブにするには、このタスクを使用してください。
重要
このタスクは非推奨であり、2024 年 1 月 31 日に廃止されます。 代わりに、bash タスクまたはバッチ スクリプト タスクで conda コマンドを直接使用します。
Conda 環境を作成してアクティブにするには、このタスクを使用してください。
重要
このタスクは非推奨になりました。 代わりに、bash タスクまたはバッチ スクリプト タスクで conda コマンドを直接使用します。
Conda 環境を作成してアクティブ化します。
構文
# Conda environment v1
# This task is deprecated. Use `conda` directly in script to work with Anaconda environments.
- task: CondaEnvironment@1
inputs:
#createCustomEnvironment: false # boolean. Create a custom environment. Default: false.
#environmentName: # string. Required when createCustomEnvironment == true. Environment name.
#packageSpecs: 'python=3' # string. Package specs. Default: python=3.
#updateConda: true # boolean. Update to the latest Conda. Default: true.
#installOptions: # string. Optional. Use when createCustomEnvironment == false. Other options for `conda install`.
#createOptions: # string. Optional. Use when createCustomEnvironment == true. Other options for `conda create`.
#cleanEnvironment: false # boolean. Optional. Use when createCustomEnvironment == true. Clean the environment. Default: false.
# Conda Environment v1
# Create and activate a Conda environment.
- task: CondaEnvironment@1
inputs:
#createCustomEnvironment: false # boolean. Create a custom environment. Default: false.
#environmentName: # string. Required when createCustomEnvironment == true. Environment name.
#packageSpecs: 'python=3' # string. Package specs. Default: python=3.
#updateConda: true # boolean. Update to the latest Conda. Default: true.
#installOptions: # string. Optional. Use when createCustomEnvironment == false. Other options for `conda install`.
#createOptions: # string. Optional. Use when createCustomEnvironment == true. Other options for `conda create`.
#cleanEnvironment: false # boolean. Optional. Use when createCustomEnvironment == true. Clean the environment. Default: false.
入力
createCustomEnvironment
-
カスタム環境を作成する
boolean
. 既定値: false
。
このブール値の値が に true
設定されている場合、タスクは 環境を使用する代わりに Conda 環境を 作成 または再アクティブ化します base
。 セルフホステッド エージェントでは、値を に true
設定することをお勧めします。
environmentName
-
環境名
string
.
createCustomEnvironment == true
の場合に必要です。
作成およびアクティブ化する Conda 環境の名前。既に存在する場合は再アクティブ化します。
packageSpecs
-
パッケージ スペック
string
. 既定値: python=3
。
環境にインストールするパッケージのスペース区切りのリスト。
updateConda
-
最新の Conda に更新する
boolean
. 既定値: true
。
Conda を最新バージョンに更新します。 これは、 または で PATH
見つかった Conda インストールが環境変数で指定されたパスに CONDA
適用されます。
installOptions
-
その他のオプション conda install
string
. 省略可能。 の場合は createCustomEnvironment == false
を使用します。
コマンドに渡す conda install
追加の引数のスペース区切りのリスト。
createOptions
-
その他のオプション conda create
string
. 省略可能。 の場合は createCustomEnvironment == true
を使用します。
コマンドに渡す conda create
追加オプションのスペース区切りのリスト。
cleanEnvironment
-
環境をクリーンアップする
boolean
. 省略可能。 の場合は createCustomEnvironment == true
を使用します。 既定値: false
。
環境を削除し、既に存在する場合は再作成します。 このブール値が選択されていない場合、タスクは既存の環境を再アクティブ化します。
タスク制御オプション
すべてのタスクには、タスク入力に加えて制御オプションがあります。 詳細については、「 コントロール オプションと一般的なタスク プロパティ」を参照してください。
出力変数
[なし] :
解説
Conda 環境を作成してアクティブにするには、このタスクを使用してください。
重要
このタスクは非推奨になりました。 代わりに、bash タスクまたはバッチ スクリプト タスクで conda コマンドを直接使用します。
このタスクでは、Conda 環境が作成され、後続のビルド タスク用にアクティブ化されます。
タスクにより、同じ名前の既存の環境が検出された場合、タスクは単にこれを再アクティブ化します。 これは、セルフホステッド エージェントで可能です。 環境を再作成し、そのパッケージのいずれかを再インストールするには、"環境をクリーンアップする" オプションを設定してください。
"最新の Conda に更新する" オプションを実行すると、環境を作成またはアクティブ化する前に Conda の更新が試みられます。 セルフホステッド エージェントを実行していて、タスクで動作するように Conda インストールを構成している場合は、Conda のインストールが更新される可能性があります。
注意
Microsoft ホステッド エージェントでは、既定では PATH
に Conda は含まれていません。 Conda を使用するには、このタスクを実行する必要があります。
このタスクを実行すると、PATH
にはアクティブ化された環境のバイナリ ディレクトリと、その後に Conda インストール自体のバイナリ ディレクトリが含まれます。
スクリプトは、インストールする他のパッケージから Python、Conda、またはコマンドライン ユーティリティを実行する後続のビルド タスクとして実行できます。
たとえば、pytest を使用してテストを実行したり、Anaconda クライアントを使用して Anaconda Cloud にパッケージをアップロードしたりできます。
ヒント
このタスクを実行すると、環境が "アクティブ化" され、conda install
を呼び出してインストールしたパッケージがこの環境にインストールされます。
必須コンポーネント
- Microsoft ホステッド エージェント、または Anaconda か Miniconda がインストールされているセルフホステッド エージェント。
- セルフホステッド エージェントを使用する場合は、
PATH
にconda
実行可能ファイルを追加するか、CONDA
環境変数を Conda インストールのルートに設定する必要があります。
このタスクを使用するようにセルフホステッド エージェントを構成するにはどうすればよいですか?
このタスクは、完全な Anaconda インストールまたは Miniconda インストールのいずれかで使用できます。
セルフホステッド エージェントを使用する場合は、conda
実行可能ファイルを PATH
に追加する必要があります。
または、CONDA
環境変数を Conda インストールのルート (つまり、Conda のインストール時に "プレフィックス" として指定したディレクトリ) に設定することもできます。
要件
要件 | 説明 |
---|---|
パイプラインの種類 | YAML、クラシック ビルド、クラシック リリース |
上で実行 | エージェント、DeploymentGroup |
確認要求 | なし |
Capabilities | このタスクは、ジョブ内の後続のタスクに対する要求を満たしていません。 |
コマンドの制限 | Any |
設定可能な変数 | Any |
エージェントのバージョン | サポートされているすべてのエージェント バージョン。 |
タスクのカテゴリ | パッケージ |