Npm@1 - npm v1 タスク

  • [アーティクル]

npm パッケージをインストールして発行したり、コマンドを実行したりするには、このタスクを npm 使用します。 npmjs.com Azure Artifacts などの認証済みレジストリをサポートし、認証します。

注意

npm 認証タスクは、Azure Artifacts で認証するための推奨される方法です。 このタスクでは、新しい機能を取り入れず、重大なバグにのみ対処します。

構文

# npm v1
# Install and publish npm packages, or run an npm command. Supports npmjs.com and authenticated registries like Azure Artifacts.
- task: Npm@1
  inputs:
    command: 'install' # 'ci' | 'install' | 'publish' | 'custom'. Required. Command. Default: install.
    #workingDir: # string. Working folder that contains package.json. 
    #customCommand: # string. Required when command = custom. Command and arguments. 
  # Advanced
    #verbose: # boolean. Optional. Use when command = install || command = ci || command = publish. Verbose logging. 
    #publishPackageMetadata: true # boolean. Optional. Use when command = publish && publishRegistry = useFeed && command = install || command = ci || command = publish. Publish pipeline metadata. Default: true.
  # Custom registries and authentication
    #customRegistry: 'useNpmrc' # 'useNpmrc' | 'useFeed'. Optional. Use when command = install || command = ci || command = custom. Registries to use. Default: useNpmrc.
    #customFeed: # string. Required when customRegistry = useFeed && command = install || command = ci || command = custom. Use packages from this Azure Artifacts/TFS registry. 
    #customEndpoint: # string. Optional. Use when customRegistry = useNpmrc && command = install || command = ci || command = custom. Credentials for registries outside this organization/collection. 
  # Destination registry and authentication
    #publishRegistry: 'useExternalRegistry' # 'useExternalRegistry' | 'useFeed'. Optional. Use when command = publish. Registry location. Default: useExternalRegistry.
    #publishFeed: # string. Required when publishRegistry = useFeed && command = publish. Target registry. 
    #publishEndpoint: # string. Required when publishRegistry = useExternalRegistry && command = publish. External Registry.

# npm v1
# Install and publish npm packages, or run an npm command. Supports npmjs.com and authenticated registries like Azure Artifacts.
- task: Npm@1
  inputs:
    command: 'install' # 'install' | 'publish' | 'custom'. Required. Command. Default: install.
    #workingDir: # string. Working folder that contains package.json. 
    #customCommand: # string. Required when command = custom. Command and arguments. 
  # Advanced
    #verbose: # boolean. Optional. Use when command = install || command = publish. Verbose logging. 
    #publishPackageMetadata: true # boolean. Optional. Use when command = publish && publishRegistry = useFeed && command = install || command = publish. Publish pipeline metadata. Default: true.
  # Custom registries and authentication
    #customRegistry: 'useNpmrc' # 'useNpmrc' | 'useFeed'. Optional. Use when command = install || command = custom. Registries to use. Default: useNpmrc.
    #customFeed: # string. Required when customRegistry = useFeed && command = install || command = custom. Use packages from this Azure Artifacts/TFS registry. 
    #customEndpoint: # string. Optional. Use when customRegistry = useNpmrc && command = install || command = custom. Credentials for registries outside this organization/collection. 
  # Destination registry and authentication
    #publishRegistry: 'useExternalRegistry' # 'useExternalRegistry' | 'useFeed'. Optional. Use when command = publish. Registry location. Default: useExternalRegistry.
    #publishFeed: # string. Required when publishRegistry = useFeed && command = publish. Target registry. 
    #publishEndpoint: # string. Required when publishRegistry = useExternalRegistry && command = publish. External Registry.

# npm v1
# Install and publish npm packages, or run an npm command. Supports npmjs.com and authenticated registries like Package Management.
- task: Npm@1
  inputs:
    command: 'install' # 'install' | 'publish' | 'custom'. Required. Command. Default: install.
    #workingDir: # string. Working folder with package.json. 
    #customCommand: # string. Required when command = custom. Command and arguments. 
  # Advanced
    #verbose: # boolean. Optional. Use when command = install || command = publish. Verbose logging. 
  # Custom registries and authentication
    #customRegistry: 'useNpmrc' # 'useNpmrc' | 'useFeed'. Optional. Use when command = install || command = custom. Registries to use. Default: useNpmrc.
    #customFeed: # string. Required when customRegistry = useFeed && command = install || command = custom. Use packages from this Azure Artifacts/TFS registry. 
    #customEndpoint: # string. Optional. Use when customRegistry = useNpmrc && command = install || command = custom. Credentials for registries outside this account/collection. 
  # Destination registry and authentication
    #publishRegistry: 'useExternalRegistry' # 'useExternalRegistry' | 'useFeed'. Optional. Use when command = publish. Registry location. Default: useExternalRegistry.
    #publishFeed: # string. Required when publishRegistry = useFeed && command = publish. Target registry. 
    #publishEndpoint: # string. Required when publishRegistry = useExternalRegistry && command = publish. External Registry.

入力

command - コマンド
string. 必須です。 使用できる値: ci、、installpublish、custom。 既定値: install。

コマンドと引数を指定します。この引数は、実行のために に npm 渡されます。

引数に二重引用符 () が含まれている場合は、それらをスラッシュ ("\) でエスケープし、エスケープされた文字列を二重引用符 (") で囲みます。


command - コマンド
string. 必須です。 許可値: install、publish、custom。 既定値: install。

コマンドと引数を指定します。この引数は、実行のために に npm 渡されます。

引数に二重引用符 () が含まれている場合は、それらをスラッシュ ("\) でエスケープし、エスケープされた文字列を二重引用符 (") で囲みます。


workingDir - package.jsonを含む作業フォルダー
string.

ターゲット package.json と .npmrc ファイルを含むフォルダーへのパスを指定します。 ファイルではなくフォルダーを選択します。 例: /packages/mypackage.


workingDir - package.jsonを使用した作業フォルダー
string.

ターゲット package.json と .npmrc ファイルを含むフォルダーへのパスを指定します。 ファイルではなくフォルダーを選択します。 例: /packages/mypackage.


verbose - 詳細ログ
boolean. 省略可能。 の場合は command = install || command = ci || command = publishを使用します。

タスクの実行時にコンソールに詳細情報を出力します。


verbose - 詳細ログ
boolean. 省略可能。 の場合は command = install || command = publishを使用します。

タスクの実行時にコンソールに詳細情報を出力します。


customCommand - コマンドと引数
string. command = custom の場合に必要です。

カスタム コマンドを実行します。 例: dist-tag ls mypackage.


customRegistry - 使用するレジストリ
string. 省略可能。 の場合は command = install || command = ci || command = customを使用します。 使用できる値: useNpmrc (.npmrc のレジストリ) useFeed 、(ここで選択するレジストリ)。 既定値: useNpmrc。

使用するレジストリを指定します。 ファイルを .npmrc ソース コード リポジトリにコミットし、そのパスを値として設定するか、Azure Artifacts のレジストリを値として指定します。


customRegistry - 使用するレジストリ
string. 省略可能。 の場合は command = install || command = customを使用します。 使用できる値: useNpmrc (.npmrc のレジストリ) useFeed 、(ここで選択するレジストリ)。 既定値: useNpmrc。

使用するレジストリを指定します。 ファイルを .npmrc ソース コード リポジトリにコミットし、そのパスを値として設定するか、Azure Artifacts のレジストリを値として指定します。


customFeed - この Azure Artifacts/TFS レジストリのパッケージを使用する
string. customRegistry = useFeed && command = install || command = ci || command = custom の場合に必要です。

生成 .npmrcされた に選択したフィードが含まれます。 プロジェクト スコープフィードの場合は、 または を使用 ProjectName/FeedName します ProjectID/FeedID。 organizationスコープのフィードの場合、値はフィード名にする必要があります。


customFeed - この Azure Artifacts/TFS レジストリのパッケージを使用する
string. customRegistry = useFeed && command = install || command = custom の場合に必要です。

生成 .npmrcされた に選択したフィードが含まれます。 プロジェクト スコープフィードの場合は、 または を使用 ProjectName/FeedName します ProjectID/FeedID。 organizationスコープのフィードの場合、値はフィード名にする必要があります。


customEndpoint - このorganization/コレクション外のレジストリの資格情報
string. 省略可能。 の場合は customRegistry = useNpmrc && command = install || command = ci || command = customを使用します。

プロジェクト .npmrcの にある外部レジストリに使用する資格情報。 このアカウント/コレクション内のレジストリの場合は、この空白のままにします。タスクでは、ビルドの資格情報が自動的に使用されます。


customEndpoint - このorganization/コレクション外のレジストリの資格情報
string. 省略可能。 の場合は customRegistry = useNpmrc && command = install || command = customを使用します。

プロジェクト .npmrcの にある外部レジストリに使用する資格情報。 このアカウント/コレクション内のレジストリの場合は、この空白のままにします。タスクでは、ビルドの資格情報が自動的に使用されます。


customEndpoint - このアカウント/コレクション以外のレジストリの資格情報
string. 省略可能。 の場合は customRegistry = useNpmrc && command = install || command = customを使用します。

プロジェクト .npmrcの にある外部レジストリに使用する資格情報。 このアカウント/コレクション内のレジストリの場合は、この空白のままにします。タスクでは、ビルドの資格情報が自動的に使用されます。


publishRegistry - レジストリの場所
string. 省略可能。 の場合は command = publishを使用します。 使用できる値: useExternalRegistry (外部 npm レジストリ (他のアカウント/コレクションを含む)) useFeed 、(ここで選択するレジストリ)。 既定値: useExternalRegistry。

コマンドの対象となるレジストリを指定します。


publishFeed - ターゲット レジストリ
string. publishRegistry = useFeed && command = publish の場合に必要です。

アカウントでホストされているレジストリを指定します。 ここでレジストリを選択するには、パッケージ管理がインストールされ、ライセンスが付与されている必要があります。


publishPackageMetadata - パイプライン メタデータを発行する
boolean. 省略可能。 の場合は command = publish && publishRegistry = useFeed && command = install || command = ci || command = publishを使用します。 既定値: true。

ビルド/リリース パイプラインのメタデータ (実行 # とソース コード情報) をパッケージに関連付けます。


publishPackageMetadata - パイプライン メタデータを発行する
boolean. 省略可能。 の場合は command = publish && publishRegistry = useFeed && command = install || command = publishを使用します。 既定値: true。

ビルド/リリース パイプラインのメタデータ (実行 # とソース コード情報) をパッケージに関連付けます。


publishEndpoint - 外部レジストリ
string. publishRegistry = useExternalRegistry && command = publish の場合に必要です。

外部レジストリへの発行に使用する資格情報を指定します。


タスク制御オプション

すべてのタスクには、タスク入力に加えて制御オプションがあります。 詳細については、「 コントロール オプションと一般的なタスク プロパティ」を参照してください。

出力変数

[なし] :

解説

注意

Azure Pipelines を使ってパッケージをフィードに発行するには、プロジェクト コレクション ビルド サービス とプロジェクトの ビルド サービス ID を共同作成者に設定する必要があります。 詳しくは、新しいユーザー/グループの追加に関する記事をご覧ください。

npm コマンドと引数について、どこで学習できますか?

例

要件

要件 説明
パイプラインの種類 YAML、クラシック ビルド、クラシック リリース
上で実行 エージェント、DeploymentGroup
確認要求 セルフホステッド エージェントには、このタスクを使用するジョブを実行するための次の要求に一致する機能が必要です: npm
Capabilities このタスクは、ジョブ内の後続のタスクに対する要求を満たしていません。
コマンドの制限 Any
設定可能な変数 Any
エージェントのバージョン 2.115.0 以上
タスクのカテゴリ パッケージ
要件 説明
パイプラインの種類 YAML、クラシック ビルド、クラシック リリース
上で実行 エージェント、DeploymentGroup
確認要求 セルフホステッド エージェントには、このタスクを使用するジョブを実行するための次の要求に一致する機能が必要です: npm
Capabilities このタスクは、ジョブ内の後続のタスクに対する要求を満たしていません。
コマンドの制限 Any
設定可能な変数 Any
エージェントのバージョン 1.91.0 以上
タスクのカテゴリ パッケージ