Compartilhar via


Npm@1 – tarefa npm v1

Use esta tarefa para instalar e publicar pacotes npm ou para executar um npm comando. npmjs.com Dá suporte a registros autenticados e como o Azure Artifacts.

Observação

A tarefa npm Authenticate é a maneira recomendada de autenticar com o Azure Artifacts. Essa tarefa não usa mais novos recursos e apenas bugs críticos são abordados.

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órios. Valores permitidos: ci, install, , publish. custom Valor padrão: install.

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

Se os argumentos contiverem aspas duplas ("), escape-as com uma barra (\) e coloque a cadeia de caracteres com aspas duplas (").


command - Comando
string. Obrigatórios. Valores permitidos: install, publish, custom. Valor padrão: install.

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

Se os argumentos contiverem aspas duplas ("), escape-as com uma barra (\) e coloque a cadeia de caracteres 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 arquivos. Selecione a pasta, não o arquivo. 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 arquivos. Selecione a pasta, não o arquivo. Exemplo: /packages/mypackage.


verbose - Log detalhado
boolean. Opcional. Use quando command = install || command = ci || command = publish.

Imprime mais informações no console quando a tarefa é executada.


verbose - Log detalhado
boolean. Opcional. Use quando command = install || command = publish.

Imprime mais informações no console quando a tarefa é executada.


customCommand - Comando e argumentos
string. Obrigatório quando command = custom.

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


customRegistry - Registros a serem usados
string. Opcional. Use quando command = install || command = ci || command = custom. Valores permitidos: useNpmrc (Registros no meu .npmrc) useFeed (Registro que seleciono aqui). Valor padrão: useNpmrc.

Especifica os registros a serem usados. Confirme um .npmrc arquivo no repositório de código-fonte e defina seu caminho como o valor ou especifique um registro do Azure Artifacts como o valor.


customRegistry - Registros a serem usados
string. Opcional. Use quando command = install || command = custom. Valores permitidos: useNpmrc (Registros no meu .npmrc) useFeed (Registro que seleciono aqui). Valor padrão: useNpmrc.

Especifica os registros a serem usados. Confirme um .npmrc arquivo no repositório de código-fonte e defina seu caminho como o valor ou especifique um registro do Azure Artifacts como o valor.


customFeed - Usar pacotes deste registro do Azure Artifacts/TFS
string. Obrigatório quando customRegistry = useFeed && command = install || command = ci || command = custom.

Inclui o feed selecionado no gerado .npmrc. Para feeds no escopo do projeto, use ProjectName/FeedName ou ProjectID/FeedID. Para feeds com escopo da organização, o valor deve ser o nome do feed.


customFeed - Usar pacotes deste registro do Azure Artifacts/TFS
string. Obrigatório quando customRegistry = useFeed && command = install || command = custom.

Inclui o feed selecionado no gerado .npmrc. Para feeds no escopo do projeto, use ProjectName/FeedName ou ProjectID/FeedID. Para feeds com escopo da organização, o valor deve ser o nome do feed.


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

Credenciais a serem usadas para registros externos localizados no do projeto .npmrc. Deixe isso em branco para registros nesta conta/coleção; a tarefa usa as credenciais do build automaticamente.


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

Credenciais a serem usadas para registros externos localizados no do projeto .npmrc. Deixe isso em branco para registros nesta conta/coleção; a tarefa usa as credenciais do build automaticamente.


customEndpoint - Credenciais para registros fora dessa conta/coleção
string. Opcional. Use quando customRegistry = useNpmrc && command = install || command = custom.

Credenciais a serem usadas para registros externos localizados no do projeto .npmrc. Deixe isso em branco para registros nesta conta/coleção; a tarefa usa as credenciais do build automaticamente.


publishRegistry - Local do Registro
string. Opcional. Use quando command = publish. Valores permitidos: useExternalRegistry (Registro npm externo (incluindo outras contas/coleções)), useFeed (Registro que seleciono aqui). Valor padrão: useExternalRegistry.

Especifica o registro que o comando terá como destino.


publishFeed - Registro de destino
string. Obrigatório quando publishRegistry = useFeed && command = publish.

Especifica um registro hospedado na conta. Você deve ter o Gerenciamento de Pacotes instalado e licenciado para selecionar um registro aqui.


publishPackageMetadata - Publicar metadados de pipeline
boolean. Opcional. Use quando command = publish && publishRegistry = useFeed && command = install || command = ci || command = publish. Valor padrão: true.

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


publishPackageMetadata - Publicar metadados de pipeline
boolean. Opcional. Use quando command = publish && publishRegistry = useFeed && command = install || command = publish. Valor padrão: true.

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


publishEndpoint - Registro Externo
string. Obrigatório quando publishRegistry = useExternalRegistry && command = publish.

Especifica as credenciais a serem usadas para publicação em um registro externo.


Opções de controle da tarefa

Todas as tarefas têm opções de controle além de suas entradas de tarefa. Para obter mais informações, consulte Opções de controle e propriedades comuns da tarefa.

Variáveis de saída

Nenhum.

Comentários

Observação

O Serviço de Build de Coleção de Projetos e a identidade do Serviço de Build do projeto devem ser definidos como Colaborador para publicar seus pacotes em um feed usando o Azure Pipelines. Confira Adicionar novos usuários/grupos para obter mais detalhes.

Onde posso aprender comandos e argumentos de npm?

Exemplos

Requisitos

Requisito Descrição
Tipos de pipeline YAML, build clássico, versão clássica
É executado em Agent, DeploymentGroup
Demandas Os agentes auto-hospedados devem ter recursos que correspondam às seguintes demandas para executar trabalhos que usam esta tarefa: npm
Funcionalidades Essa tarefa não atende a nenhuma demanda por tarefas subsequentes no trabalho.
Restrições de comando Qualquer
Variáveis configuráveis Qualquer
Versão do agente 2.115.0 ou superior
Categoria da tarefa Pacote
Requisito Descrição
Tipos de pipeline YAML, build clássico, versão clássica
É executado em Agent, DeploymentGroup
Demandas Os agentes auto-hospedados devem ter recursos que correspondam às seguintes demandas para executar trabalhos que usam esta tarefa: npm
Funcionalidades Essa tarefa não atende a nenhuma demanda por tarefas subsequentes no trabalho.
Restrições de comando Qualquer
Variáveis configuráveis Qualquer
Versão do agente 1.91.0 ou superior
Categoria da tarefa Pacote