Npm@1 - tarefa npm v1

Utilize esta tarefa para instalar e publicar pacotes npm ou para executar um npm comando. npmjs.com Suporta e autentica registos como os Artefactos do Azure.

Nota

A tarefa npm Authenticate é a forma recomendada de autenticar com os Artefactos do Azure. Esta tarefa já não utiliza novas funcionalidades e apenas são resolvidos erros críticos.

Syntax

# 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.

Entradas

command - Comando
string. Obrigatório. Valores permitidos: ci, install, publish, custom. Valor predefinido: install.

Especifica o comando e os argumentos, que são transmitidos para a npm execução.

Se os seus argumentos contiverem aspas duplas ("), escape-as com uma barra (\) e rodeie a cadeia escapada com aspas duplas (").


command - Comando
string. Obrigatório. Valores permitidos: install, , publishcustom. Valor predefinido: install.

Especifica o comando e os argumentos, que são transmitidos para a npm execução.

Se os seus argumentos contiverem aspas duplas ("), escape-as com uma barra (\) e rodeie a cadeia escapada com aspas duplas (").


workingDir - Pasta de trabalho que contém package.json
string.

Especifica o caminho para a pasta que contém o destino package.json e .npmrc os ficheiros. Selecione a pasta e não o ficheiro. Exemplo: /packages/mypackage.


workingDir - Pasta de trabalho com package.json
string.

Especifica o caminho para a pasta que contém o destino package.json e .npmrc os ficheiros. Selecione a pasta e não o ficheiro. Exemplo: /packages/mypackage.


verbose - Registo verboso
boolean. Opcional. Utilize quando command = install || command = ci || command = publish.

Imprime mais informações na consola quando a tarefa é executada.


verbose - Registo verboso
boolean. Opcional. Utilize quando command = install || command = publish.

Imprime mais informações na consola quando a tarefa é executada.


customCommand - Comando e argumentos
string. Necessário quando command = custom.

Executa um comando personalizado. Exemplo: dist-tag ls mypackage.


customRegistry - Registos a utilizar
string. Opcional. Utilize quando command = install || command = ci || command = custom. Valores permitidos: useNpmrc (Registos no meu .npmrc), useFeed (Registo selecionado aqui). Valor predefinido: useNpmrc.

Especifica os registos a utilizar. Consolide um .npmrc ficheiro no seu repositório de código fonte e defina o respetivo caminho como o valor ou especifique um registo dos Artefactos do Azure como o valor.


customRegistry - Registos a utilizar
string. Opcional. Utilize quando command = install || command = custom. Valores permitidos: useNpmrc (Registos no meu .npmrc), useFeed (Registo selecionado aqui). Valor predefinido: useNpmrc.

Especifica os registos a utilizar. Consolide um .npmrc ficheiro no seu repositório de código fonte e defina o respetivo caminho como o valor ou especifique um registo dos Artefactos do Azure como o valor.


customFeed - Utilizar pacotes deste registo de Artefactos do Azure/TFS
string. Necessário quando customRegistry = useFeed && command = install || command = ci || command = custom.

Inclui o feed selecionado no .npmrc. Para feeds com âmbito de projeto, utilize ProjectName/FeedName ou ProjectID/FeedID. Para feeds no âmbito da organização, o valor deve ser o nome do feed.


customFeed - Utilizar pacotes deste registo de Artefactos do Azure/TFS
string. Necessário quando customRegistry = useFeed && command = install || command = custom.

Inclui o feed selecionado no .npmrc. Para feeds com âmbito de projeto, utilize ProjectName/FeedName ou ProjectID/FeedID. Para feeds no âmbito da organização, o valor deve ser o nome do feed.


customEndpoint - Credenciais para registos fora desta organização/coleção
string. Opcional. Utilize quando customRegistry = useNpmrc && command = install || command = ci || command = custom.

Credenciais a utilizar para registos externos localizados no .npmrc. Deixe isto em branco para registos nesta conta/coleção; a tarefa utiliza automaticamente as credenciais da compilação.


customEndpoint - Credenciais para registos fora desta organização/coleção
string. Opcional. Utilize quando customRegistry = useNpmrc && command = install || command = custom.

Credenciais a utilizar para registos externos localizados no .npmrc. Deixe isto em branco para registos nesta conta/coleção; a tarefa utiliza automaticamente as credenciais da compilação.


customEndpoint - Credenciais para registos fora desta conta/coleção
string. Opcional. Utilize quando customRegistry = useNpmrc && command = install || command = custom.

Credenciais a utilizar para registos externos localizados no .npmrc. Deixe isto em branco para registos nesta conta/coleção; a tarefa utiliza automaticamente as credenciais da compilação.


publishRegistry - Localização do registo
string. Opcional. Utilize quando command = publish. Valores permitidos: useExternalRegistry (Registo npm externo (incluindo outras contas/coleções)), useFeed (Registo selecionado aqui). Valor predefinido: useExternalRegistry.

Especifica o registo que o comando terá como destino.


publishFeed - Registo de destino
string. Necessário quando publishRegistry = useFeed && command = publish.

Especifica um registo alojado na conta. Tem de ter a Gestão de Pacotes instalada e licenciada para selecionar um registo aqui.


publishPackageMetadata - Publicar metadados do pipeline
boolean. Opcional. Utilize quando command = publish && publishRegistry = useFeed && command = install || command = ci || command = publish. Valor predefinido: true.

Associa os metadados do pipeline de compilação/versão (as informações de código fonte e #de execução) ao pacote.


publishPackageMetadata - Publicar metadados do pipeline
boolean. Opcional. Utilize quando command = publish && publishRegistry = useFeed && command = install || command = publish. Valor predefinido: true.

Associa os metadados do pipeline de compilação/versão (as informações de código fonte e #de execução) ao pacote.


publishEndpoint - Registo Externo
string. Necessário quando publishRegistry = useExternalRegistry && command = publish.

Especifica as credenciais a utilizar para publicar num registo externo.


Opções de controlo de tarefas

Todas as tarefas têm opções de controlo para além das entradas de tarefas. Para obter mais informações, veja Opções de controlo e propriedades de tarefas comuns.

Variáveis de saída

Nenhum.

Observações

Nota

O Serviço de Compilação da Coleção de Projetos e a identidade do Serviço de Compilação do projeto têm de ser definidos como Contribuidor para publicar os seus pacotes num feed com o Azure Pipelines. Consulte Adicionar novos utilizadores/grupos para obter mais detalhes.

Onde posso aprender comandos e argumentos npm?

Exemplos

Requisitos

Requisito Description
Tipos de pipeline YAML, Compilação clássica, Versão clássica
É executado em Agente, DeploymentGroup
Exigências Os agentes autoalojados têm de ter capacidades que correspondam às seguintes exigências para executar tarefas que utilizam esta tarefa: npm
Capacidades Esta tarefa não satisfaz quaisquer exigências para tarefas subsequentes na tarefa.
Restrições de comandos Qualquer
Variáveis de tabelas definidas Qualquer
Versão do agente 2.115.0 ou superior
Categoria da tarefa Pacote
Requisito Description
Tipos de pipeline YAML, Compilação clássica, Versão clássica
É executado em Agente, DeploymentGroup
Exigências Os agentes autoalojados têm de ter capacidades que correspondam às seguintes exigências para executar tarefas que utilizam esta tarefa: npm
Capacidades Esta tarefa não satisfaz quaisquer exigências para tarefas subsequentes na tarefa.
Restrições de comandos Qualquer
Variáveis de tabelas definidas Qualquer
Versão do agente 1.91.0 ou superior
Categoria da tarefa Pacote