Esta página foi traduzida pela API Cloud Translation.
Switch to English

Como gerenciar pacotes de npm

Nesta página, descrevemos as seguintes tarefas:

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

O gerenciamento de pacotes está em Alfa. Ele só está disponível para usuários Alfa e pode não incluir todos os recursos disponíveis para o gerenciamento de contêineres. Para se inscrever no Alfa, preencha o formulário de inscrição.

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.

Como adicionar pacotes

Só é possível publicar uma versão específica de um pacote uma vez. Essa é uma restrição npm para garantir que o conteúdo de uma versão de pacote publicada seja sempre o mesmo. Como resultado, você não poderá:

  • 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

Para adicionar um pacote:

  1. Certifique-se de que o nome do pacote em package.json inclua o escopo configurado para seu repositório. O exemplo a seguir mostra um pacote com o escopo dev-repo.

    "name": "@dev-repo/my-package"
    
  2. Atualize o token de acesso para se conectar ao repositório. google-artifactregistry-auth é uma biblioteca de cliente que atualiza as credenciais dos repositórios do Artifact Registry.

    Para atualizar as credenciais, use uma destas opções:

    • Use npx diretamente para atualizar o token de acesso. Se você estiver usando o npm 5.2.0 ou mais recente, ele estará incluído no npm.

      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 comando a seguir na pasta acima do projeto npm.

      npx google-artifactregistry-auth PROJECT-NPMRC
      

      Em que PROJECT-NPMRC é o caminho para o arquivo .npmrc no diretório do projeto.

      É necessário executar o comando fora do diretório do projeto para que npx use suas credenciais públicas de registro npm em ~/.npmrc para fazer o download de google-artifactregistry-auth.

    • Adicione um script ao arquivo package.json no seu projeto.

      "scripts": {
        "artifactregistry-login": "npx google-artifactregistry-auth"
      }
      
      npm run artifactregistry-login PROJECT-NPMRC --registry https://registry.npmjs.org/
      

      Em que PROJECT-NPMRC é o caminho para o arquivo .npmrc no diretório do projeto.

    • Para versões do NPM anteriores à 5.2.0, siga estas etapas:

      1. Execute o comando:
      npm install google-artifactregistry-auth --save-dev --registry https://registry.npmjs.org/
      
      1. Adicione-o a um script de autenticação:
      "scripts": {
          "artifactregistry-login": "./node_modules/.bin/artifactregistry-auth",
      }
      

      Executar o script

      npm run artifactregistry-login PROJECT-NPMRC
      

      Em que PROJECT-NPMRC é o caminho para o arquivo .npmrc no diretório do projeto.

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

    npm publish
    
    yarn publish
    

Como visualizar pacotes e versões

Para ver informações do pacote com npm ou yarn, 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.

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 a partir do repositório npm, use o comando npm install ou yarn add.

npm install @SCOPE/PACKAGE
yarn add @SCOPE/PACKAGE

Onde

  • SCOPE é o escopo associado ao repositório.
  • PACKAGE é o nome do pacote no repositório.

Se seu repositório npm não estiver configurado com um escopo, omita o escopo do comando:

npm install PACKAGE
yarn add PACKAGE

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

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

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 npm para garantir que o conteúdo de uma versão de pacote publicada 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.

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

  • 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 \
    [--repository=REPOSITORY] [--location=LOCATION] [--async]

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.
  • --async retorna imediatamente, sem aguardar a conclusão da operação em andamento.

A seguir