Como gerenciar pacotes do Node.js

Nesta página, descrevemos as seguintes tarefas:

  • Como visualizar e excluir pacotes e versões de pacote
  • Como visualizar, criar, atualizar e excluir tags

Antes de começar

  1. Se não existir um repositório de destino, crie um novo repositório.
  2. Verifique se você tem as permissões necessárias para o repositório.
  3. Configure a autenticação do npm.
  4. (Opcional) Configure padrões para comandos gcloud.
  5. Se você estiver usando o auxiliar de credenciais do NPM para autenticação, consiga um token de acesso antes de se conectar a um repositório com o npm.

Como conseguir um token de acesso

Os tokens de acesso são válidos por 60 minutos. Gere um token de acesso pouco antes de executar comandos que interajam com repositórios.

Para receber um token, use uma destas opções:

  • Use o comando npx para atualizar o token de acesso.

    1. Verifique se as credenciais para se conectar ao registro npm público estão no arquivo de configuração do npm do usuário, ~/.npmrc.

    2. Execute o seguinte comando no diretório do seu projeto Node.js.

      npx google-artifactregistry-auth
      
  • Adicione um script ao arquivo package.json no seu projeto.

    "scripts": {
     "artifactregistry-login": "npx google-artifactregistry-auth"
    }
    

    Execute o script no diretório do projeto Node.js.

    npm run artifactregistry-login
    

O Artifact Registry lê as configurações de repositório do Artifact Registry no arquivo .npmrc do seu projeto e as usa para adicionar credenciais de token ao seu arquivo .npmrc do usuário. O armazenamento do token no arquivo .npmrc do usuário isola as credenciais do código-fonte e do sistema de controle de origem.

Como adicionar pacotes

Só é possível publicar uma versão específica de um pacote uma vez. Essa é uma restrição de npm para garantir que o conteúdo da versão de um pacote publicado seja sempre o mesmo. Sendo assim, não é possível:

  • Substituir uma versão do pacote publicando-a novamente no repositório
  • Remover um pacote ou sua versão do repositório e, em seguida, publicar um pacote com o mesmo nome e número da versão

Se você não especificar uma tag ao publicar um pacote, o npm adicionará a tag latest. Para simplificar a instalação dos pacotes em um estágio de desenvolvimento específico, considere publicá-los com uma tag, como beta ou dev.

Para adicionar um pacote:

  1. Verifique se o nome do pacote em package.json inclui o escopo configurado para o repositório. No exemplo a seguir, mostramos um pacote com o escopo dev-repo.

    "name": "@dev-repo/my-package"
    
  2. Se você estiver usando o auxiliar de credenciais para autenticar com um token de acesso, consiga um novo token.

  3. Adicione pacotes ao repositório. Use um comando npm ou yarn.

    Para marcar o pacote, inclua a sinalização --tag e substitua TAG pela tag que você quer usar. Se você não incluir a sinalização --tag, o NPM definirá automaticamente a tag como latest.

    npm publish --tag=TAG
    
    yarn publish --tag TAG
    

Como visualizar pacotes e versões

Para ver informações do pacote com npm ou yarn:

  1. Se você estiver usando o auxiliar de credenciais para autenticar com um token de acesso, consiga um novo token.

  2. Execute o comando apropriado:

    npm view
    
    yarn info
    

Para visualizar pacotes e versões de pacotes usando o Console do Google Cloud ou gcloud:

Console

  1. Abra a página Repositórios no Console do Google Cloud.

    Abrir a página Repositórios

  2. Na lista de repositórios, clique no repositório apropriado.

    A página Pacotes lista os pacotes no repositório.

  3. Clique em um pacote para visualizar as versões dele.

gcloud

Para listar pacotes em um repositório, execute o seguinte comando:

gcloud artifacts packages list [--repository=REPOSITORY] [--location=LOCATION]

Onde

  • REPOSITORY é o nome do repositório. Se você tiver configurado um repositório padrão, você pode omitir essa sinalização para usar o padrão.
  • LOCATION é um local regional ou multirregional. Use esta sinalização para ver repositórios em um local específico. Se você tiver configurado um local padrão, poderá omitir essa sinalização para usar o padrão.

Para ver as versões de um pacote, execute o seguinte comando:

gcloud artifacts versions list --package=PACKAGE \
    [--repository=REPOSITORY] [--location=LOCATION]

Onde

  • PACKAGE é o ID do pacote ou o identificador totalmente qualificado do pacote.
  • REPOSITORY é o nome do repositório. Se você tiver configurado um repositório padrão, você pode omitir essa sinalização para usar o padrão.
  • LOCATION é um local regional ou multirregional. Use esta sinalização para ver repositórios em um local específico. Se você tiver configurado um local padrão, poderá omitir essa sinalização para usar o padrão.

Como marcar pacotes

Você pode ver, adicionar, atualizar e excluir tags. As tags podem ajudar a gerenciar versões semânticas dos pacotes e simplificar a instalação de pacotes em uma etapa específica de desenvolvimento.

Por exemplo, você pode incluir uma tag no build atual do candidato a lançamento rc. Em seguida, sua equipe pode instalar a versão correta com base na tag em vez de um especificador de versão. Além disso, o cancelamento da publicação de versões de pré-lançamento não utilizadas não corrompe as dependências no pacote candidato a lançamento.

Como visualizar tags

Para ver as tags de um pacote:

Console

  1. Abra a página Repositórios no Console do Cloud.

    Abrir a página Repositórios

  2. Clique no pacote para visualizar as versões e tags associadas.

  3. Selecione a versão do pacote a ser marcada.

  4. Na linha da versão selecionada, clique em Mais ações (Mais ações) e, em seguida, clique em Editar tags.

  5. Insira novas tags no campo e clique em SALVAR.

gcloud

Execute o comando:

gcloud artifacts tags list --package=PACKAGE \
    [--repository=REPOSITORY] [--location=LOCATION]

Onde

  • PACKAGE é o nome do pacote no repositório.
  • REPOSITORY é o nome do repositório. Se você tiver configurado um repositório padrão, você pode omitir essa sinalização para usar o padrão.
  • LOCATION é um local regional ou multirregional. Use esta sinalização para ver repositórios em um local específico. Se você tiver configurado um local padrão, poderá omitir essa sinalização para usar o padrão.

Por exemplo, para visualizar tags para o pacote my-package no repositório my-repo no local padrão, execute o comando:

gcloud artifacts tags list --package=my-pkg --repository=my-repo

Como criar tags

Você pode criar uma tag para uma versão específica de um pacote.

Para adicionar uma tag em uma imagem atual em um repositório:

Console

  1. Abra a página Repositórios no Console do Cloud.

    Abrir a página Repositórios

  2. Clique no pacote para visualizar as versões do pacote.

  3. Selecione a versão do pacote a ser adicionar a tag.

  4. Na linha da versão selecionada, clique em Mais ações (Mais ações) e, em seguida, clique em Editar tags.

  5. Insira novas tags no campo e clique em SALVAR.

gcloud

Execute este comando:

gcloud artifacts tags create TAG --package=PACKAGE \
    version=VERSION [--location=LOCATION] [--repository=REPOSITORY]

Onde

  • TAG é a tag que você quer aplicar ao pacote.
  • PACKAGE é o nome do pacote no repositório.
  • VERSION é a versão do pacote que você quer adicionar a tag.
  • LOCATION é um local regional ou multirregional. Use esta sinalização para ver repositórios em um local específico. Se você tiver configurado um local padrão, poderá omitir essa sinalização para usar o padrão.
  • REPOSITORY é o nome do repositório. Se você tiver configurado um repositório padrão, você pode omitir essa sinalização para usar o padrão.

Por exemplo, para criar a tag release-candidate para a versão 1.0.0 do pacote my-package no repositório my-repo no local padrão, execute o comando:

gcloud artifacts tags create release-candidate --version=1.0.0 \
    --package=my-pkg --repository=my-repo

Como atualizar tags

É possível alterar uma tag associada a uma versão do pacote.

Para alterar uma tag existente, faça o seguinte:

Console

  1. Abra a página Repositórios no Console do Cloud.

    Abrir a página Repositórios

  2. Clique no pacote para visualizar as versões do pacote.

  3. Selecione a versão do pacote com a tag a ser alterada.

  4. Na linha da versão selecionada, clique em Mais ações (Mais ações) e, em seguida, clique em Editar tags.

  5. Edite a tag e clique em SALVAR.

gcloud

Execute este comando:

gcloud artifacts tags update TAG --package=PACKAGE \
    version=VERSION [--location=LOCATION] [--repository=REPOSITORY]

Onde

  • TAG é a tag que você quer aplicar ao pacote.
  • PACKAGE é o nome do pacote no repositório.
  • VERSION é a versão do pacote que você quer adicionar a tag.
  • LOCATION é um local regional ou multirregional. Use esta sinalização para ver repositórios em um local específico. Se você tiver configurado um local padrão, poderá omitir essa sinalização para usar o padrão.
  • REPOSITORY é o nome do repositório. Se você tiver configurado um repositório padrão, você pode omitir essa sinalização para usar o padrão.

Por exemplo, para alterar a tag da versão 1.0.0 do pacote my-package para production no repositório my-repo no local padrão, execute o comando:

gcloud artifacts tags update production --version=1.0.0 \
    --package=my-pkg --repository=my-repo

Como desmarcar versões do pacote

É possível remover uma tag existente de uma versão de pacote.

Para remover uma tag:

Console

  1. Abra a página Repositórios no Console do Cloud.

    Abrir a página Repositórios

  2. Clique na imagem para ver as versões dela.

  3. Selecione a versão da imagem para remover a tag.

  4. Na linha da versão selecionada, clique em Mais ações (Mais ações) e, em seguida, clique em Editar tags.

  5. Exclua a tag e clique em SALVAR.

gcloud

Execute este comando:

gcloud artifacts tags delete TAG --package=PACKAGE \
    [--location=<LOCATION] [--repository=REPOSITORY]

Onde

  • TAG é a tag que você quer aplicar ao pacote.
  • PACKAGE é o nome do pacote no repositório.
  • LOCATION é um local regional ou multirregional. Use esta sinalização para ver repositórios em um local específico. Se você tiver configurado um local padrão, poderá omitir essa sinalização para usar o padrão.
  • REPOSITORY é o nome do repositório. Se você tiver configurado um repositório padrão, você pode omitir essa sinalização para usar o padrão.

Por exemplo, para remover a tag release-candidate do pacote my-package no repositório my-repo no local padrão, execute o comando:

gcloud artifacts tags delete release-candidate --package=my-pkg \
    --repository=my-repo

Como instalar pacotes

Para instalar um pacote do repositório de pacotes Node.js, siga as etapas a seguir:

  1. Se você estiver usando o auxiliar de credenciais para autenticar com um token de acesso, consiga um novo token.

  2. Use os comandos npm install ou yarn add.

    npm

    Para instalar a versão com a tag latest:

    npm install @SCOPE/PACKAGE
    

    Para instalar a versão com uma tag diferente:

    npm install @SCOPE/PACKAGE@TAG
    

    Para instalar uma versão específica:

    npm install @SCOPE/PACKAGE@VERSION
    

    yarn

    Para instalar a versão com a tag latest:

    yarn add @SCOPE/PACKAGE
    

    Para instalar a versão com uma tag diferente:

    yarn add @SCOPE/PACKAGE@TAG
    

    Para instalar uma versão específica:

    yarn add @SCOPE/PACKAGE@VERSION
    

    Substitua os seguintes valores:

    • SCOPE é o escopo associado ao repositório. Se o repositório do pacote Node.js não estiver configurado com um escopo, omita @SCOPE/ do comando.
    • PACKAGE é o nome do pacote no repositório.
    • TAG é a tag da versão que você quer instalar;
    • VERSION é o número da versão que você quer instalar;

Ao especificar um pacote como uma dependência em package.json, inclua o escopo do repositório. O exemplo a seguir mostra o escopo @dev-repo de um pacote chamado my-package.

"dependencies": {
  "@dev-repo/my-package": ">=1.0.0"
}

Como excluir pacotes

Depois que uma versão do pacote é publicada, não é possível republicar um pacote com o mesmo nome e combinação de versões, mesmo após excluir a versão. Essa é uma restrição de npm para garantir que o conteúdo de uma versão do pacote publicado seja sempre o mesmo.

Se você quiser incentivar os usuários a instalar uma versão atualizada do pacote, use o comando npm deprecate para marcar a versão antiga do pacote como obsoleta. Quando um usuário tenta instalar o pacote obsoleto, o Artifact Registry retorna um aviso de suspensão de uso.

Antes de excluir uma versão de pacote ou um pacote, verifique se você comunicou ou resolveu qualquer dependência importante nele.

Para excluir um pacote:

Console

  1. Abra a página Repositórios no Console do Google Cloud.

    Abrir a página Repositórios

  2. Na lista de repositórios, clique no repositório apropriado.

    A página Pacotes lista os pacotes no repositório.

  3. Selecione o pacote que você quer excluir.

  4. Clique em EXCLUIR.

  5. Na caixa de diálogo de confirmação, clique em Excluir.

gcloud

Execute este comando:

gcloud artifacts packages delete PACKAGE \
    [--repository=REPOSITORY] [--location=LOCATION] [--async]

Onde

  • PACKAGE é o nome do pacote no repositório.
  • REPOSITORY é o nome do repositório. Se você tiver configurado um repositório padrão, você pode omitir essa sinalização para usar o padrão.
  • LOCATION é um local regional ou multirregional. Use esta sinalização para ver repositórios em um local específico. Se você tiver configurado um local padrão, poderá omitir essa sinalização para usar o padrão.
  • --async Retorna imediatamente, sem aguardar a conclusão da operação em andamento.

Para excluir versões de um pacote:

Console

  1. Abra a página Repositórios no Console do Google Cloud.

    Abrir a página Repositórios

  2. Na lista de repositórios, clique no repositório apropriado.

    A página Pacotes lista os pacotes no repositório.

  3. Clique em um pacote para visualizar as versões dele.

  4. Selecione as versões que você quer excluir.

  5. Clique em EXCLUIR.

  6. Na caixa de diálogo de confirmação, clique em Excluir.

gcloud

Execute este comando:

gcloud artifacts versions delete VERSION \
    --package=PACKAGE \
    [--repository=REPOSITORY] [--location=LOCATION] \
    [--async]

Onde

  • PACKAGE é o nome do pacote no repositório.
  • REPOSITORY é o nome do repositório. Se você tiver configurado um repositório padrão, você pode omitir essa sinalização para usar o padrão.
  • LOCATION é um local regional ou multirregional. Use esta sinalização para ver repositórios em um local específico. Se você tiver configurado um local padrão, poderá omitir essa sinalização para usar o padrão.
  • --async retorna imediatamente, sem aguardar a conclusão da operação em andamento.

A seguir