Armazene pacotes do Node.js no Artifact Registry

Neste guia de início rápido, mostramos como configurar um repositório de pacotes Node.js particular do Artifact Registry e fazer upload de um pacote para ele.

Antes de começar

  1. Faça login na sua conta do Google Cloud. Se você começou a usar o Google Cloud agora, crie uma conta para avaliar o desempenho de nossos produtos em situações reais. Clientes novos também recebem US$ 300 em créditos para executar, testar e implantar cargas de trabalho.
  2. No console do Google Cloud, na página do seletor de projetos, selecione ou crie um projeto do Google Cloud.

    Acessar o seletor de projetos

  3. Verifique se a cobrança está ativada para o seu projeto do Google Cloud.

  4. Ative a API Artifact Registry.

    Ative a API

  5. Instale a CLI do Google Cloud.
  6. Para inicializar a CLI gcloud, execute o seguinte comando:

    gcloud init
  7. No console do Google Cloud, na página do seletor de projetos, selecione ou crie um projeto do Google Cloud.

    Acessar o seletor de projetos

  8. Verifique se a cobrança está ativada para o seu projeto do Google Cloud.

  9. Ative a API Artifact Registry.

    Ative a API

  10. Instale a CLI do Google Cloud.
  11. Para inicializar a CLI gcloud, execute o seguinte comando:

    gcloud init
  12. Instale o PowerShell caso queira se conectar a um repositório de pacotes Node.js do Windows.

Iniciar o Cloud Shell

Neste guia de início rápido, você usará o Cloud Shell, que é um ambiente shell para gerenciar recursos hospedados no Google Cloud.

O Cloud Shell vem pré-instalado com a Google Cloud CLI. A CLI gcloud fornece a interface de linha de comando principal do Google Cloud.

Inicie o Cloud Shell:

  1. Acesse o Console do Google Cloud.

    Console do Google Cloud

  2. Na barra de ferramentas do console do Google Cloud, clique em Ativar o Cloud Shell:

Uma sessão do Cloud Shell é aberta dentro de um quadro inferior no console. Use esse shell para executar comandos gcloud.

Criar um repositório de pacotes do Node.js

Crie o repositório para seus artefatos do Node.js.

  1. Crie o repositório.

    Console

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

      Abrir a página Repositórios

    2. Clique em Criar repositório.

    3. Especifique quickstart-nodejs-repo como o nome do repositório.

    4. Escolha npm como formato e Standard como modo.

    5. Em Tipo de local, selecione Região e escolha o local us-central1.

    6. Clique em Criar.

    O repositório é adicionado à lista de repositórios

    gcloud

    1. Execute o comando a seguir para criar um novo repositório de pacotes Node.js chamado quickstart-nodejs-repo no local us-central1 com a descrição "Repositório Node.js".

      gcloud artifacts repositories create quickstart-nodejs-repo --repository-format=npm \
      --location=us-central1 --description="Node.js package repository"
      
    2. Execute o seguinte comando para verificar se o repositório foi criado.

      gcloud artifacts repositories list
      

    Para mais informações sobre os comandos do Artifact Registry, execute o comando gcloud artifacts.

  2. Para simplificar os comandos gcloud, defina o repositório padrão como quickstart-nodejs-repo e o local padrão como us-central1. Depois que os valores forem definidos, não será necessário especificá-los nos comandos gcloud que exigem um repositório ou local.

    Para definir o repositório, execute o comando:

    gcloud config set artifacts/repository quickstart-nodejs-repo
    

    Para definir o local, execute o comando:

    gcloud config set artifacts/location us-central1
    

    Saiba mais sobre esses comandos na documentação do gcloud config set.

Configurar NPM

Para fazer o upload e o download de pacotes, é preciso configurar seus projetos npm com configurações para autenticar com o repositório que você criou. Neste guia de início rápido, você fará upload de um pacote simples e o instalará em um segundo pacote como dependência.

  1. Faça o download do pacote emoji-regex, um pacote simples que fornece uma expressão regular para corresponder a todos os símbolos e sequências de emojis.

    npm pack emoji-regex
    

    O comando faz o download de um arquivo do pacote.

  2. Extraia o arquivo em um diretório emoji-regex. O comando a seguir é para um arquivo do emoji-regex versão 10.1.0:

    mkdir emoji-regex && tar xvf emoji-regex-10.1.0.tgz -C emoji-regex --strip-components 1
    
  3. Crie um segundo pacote npm que você vai usar para instalar o pacote emoji-regex do Artifact Registry. Neste pacote, use o comando npm init para criar um pacote básico.

    mkdir npm-package2
    cd npm-package2
    
    npm init -y
    

    Quando solicitado, aceite os valores padrão.

  4. Configure os projetos emoji-regex e npm-package2 para autenticar com o repositório do Artifact Registry que você criou.

    1. Execute o comando a seguir. O comando retorna definições de configuração para adicionar ao arquivo de configuração do npm.

      gcloud artifacts print-settings npm --scope=@quickstart
      

      O escopo quickstart está associado ao repositório. Quando você inclui o escopo nos comandos para publicar ou instalar pacotes, o npm usa seu repositório. Quando você publica ou instala pacotes sem um escopo, o repositório padrão configurado é usado. Para mais informações, consulte a visão geral do Node.js.

      A saída do comando gcloud vai ser semelhante ao exemplo a seguir. PROJECT é o ID do projeto no Google Cloud.

      @quickstart:registry=https://us-central1-npm.pkg.dev/PROJECT/quickstart-nodejs-repo/
      //us-central1-npm.pkg.dev/PROJECT/quickstart-nodejs-repo/:always-auth=true
      
    2. Adicione as definições de configuração da etapa anterior ao arquivo .npmrc do projeto em cada projeto npm. O arquivo no mesmo diretório que o arquivo package.json.

      Para saber mais sobre o arquivo .npmrc, consulte a visão geral do Node.js.

      Cada repositório de pacotes Node.js do Artifact Registry está associado a um endpoint de registro de NPM https://LOCATION-npm.pkg.dev/PROJECT/REPOSITORY. Se você criar outro repositório de pacotes Node.js do Artifact Registry, o npm vai interagir com ele como um registro separado com o próprio escopo.

  5. Edite package.json nos projetos emoji-regex e npm-package2.

    1. Verifique se o valor de name inclui o escopo quickstart.

      • Para obter emoji-regex:
      "name": "@quickstart/emoji-regex"
      
      • Para obter npm-package2:
      "name": "@quickstart/npm-package2"
      
    2. Em scripts, adicione um script para google-artifactregistry-auth, uma biblioteca de cliente que atualiza as credenciais dos repositórios do Artifact Registry.

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

Fazer upload de um pacote para o repositório

  1. Atualize o token de acesso para se conectar ao repositório.

    npm run artifactregistry-login
    
  2. Adicione o pacote ao repositório. Use um comando npm ou yarn.

    npm publish
    
    yarn publish
    

Ver o pacote no repositório

Para verificar se o pacote foi adicionado ao repositório:

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, selecione o repositório quickstart-nodejs-repo.

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

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

gcloud

Para listar as imagens no repositório padrão quickstart-nodejs-repo, execute o seguinte comando:

 gcloud artifacts packages list

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

gcloud artifacts versions list --package=PACKAGE

Em que PACKAGE é o ID do pacote.

Como instalar pacotes

Instale o pacote emoji-regex do repositório do Artifact Registry em npm-package2.

No diretório npm-package2, execute o comando npm install ou yarn add:

npm install @quickstart/emoji-regex
yarn add @quickstart/emoji-regex

O comando instala o pacote emoji-regex no projeto npm-package2. Ele também atualiza package.json para definir emoji-regex como uma dependência.

"dependencies": {
  "@quickstart/emoji-regex": "^10.1.0"
}

Limpar

Para evitar cobranças na sua conta do Google Cloud pelos recursos usados nesta página, siga estas etapas.

Antes de remover um repositório, verifique se os pacotes que você quer manter estão disponíveis em outro local.

Para excluir o repositório:

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, selecione o repositório quickstart-nodejs-repo.

  3. Clique em Excluir.

gcloud

  1. Para excluir o repositório quickstart-nodejs-repo, execute o seguinte comando:

    gcloud artifacts repositories delete quickstart-nodejs-repo
    
  2. Se você quiser remover as configurações padrão de repositório e localização que definiu para a configuração ativa gcloud, execute os seguintes comandos:

    gcloud config unset artifacts/repository
    gcloud config unset artifacts/location
    

A seguir