Npm@1 - npm v1 任务
使用此任务来安装和发布 npm 包或运行 npm
命令。 支持 npmjs.com
Azure Artifacts 等经过身份验证的注册表。
注意
建议使用 npm 身份验证任务通过 Azure Artifacts 进行身份验证。 此任务不再采用新功能,仅解决关键 bug。
语法
# 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
、install
、、publish
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
。 对于组织范围的源,该值应为源名称。
customFeed
- 使用此 Azure Artifacts/TFS 注册表中的包
string
. 当 customRegistry = useFeed && command = install || command = custom
时,需要此选项。
在生成的 .npmrc
中包含所选源。 对于项目范围的源,请使用 ProjectName/FeedName
或 ProjectID/FeedID
。 对于组织范围的源,该值应为源名称。
customEndpoint
- 此组织/集合外部注册表的凭据
string
. 可选。 在 时 customRegistry = useNpmrc && command = install || command = ci || command = custom
使用 。
要用于位于项目 中的外部注册表的 .npmrc
凭据。 对于此帐户/集合中的注册表,将此留空;任务会自动使用生成的凭据。
customEndpoint
- 此组织/集合外部注册表的凭据
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 将包发布到源。 有关更多详细信息,请参阅添加新用户/组。