Gestire i pacchetti Node.js

Questa pagina descrive le seguenti attività:

• Visualizzazione ed eliminazione di pacchetti e versioni dei pacchetti
• Visualizzazione, creazione, aggiornamento ed eliminazione di tag

Prima di iniziare

1. Se il repository di destinazione non esiste, creane uno nuovo.
2. Verifica di disporre delle autorizzazioni necessarie per il repository.
3. Configura l'autenticazione per npm.
4. (Facoltativo) Configura i valori predefiniti per i comandi gcloud.
5. Se utilizzi l'utilità di supporto delle credenziali npm per l'autenticazione, ottieni un token di accesso prima di collegarti a un repository con npm.

Ruoli obbligatori

Per ottenere le autorizzazioni necessarie per gestire i pacchetti, chiedi all'amministratore di concederti i seguenti ruoli IAM nel repository:

• Visualizza pacchetti, file nei pacchetti e tag: Artifact Registry Reader (roles/artifactregistry.reader)
• Scarica o installa i pacchetti: Artifact Registry Reader (roles/artifactregistry.reader)
• Aggiungi pacchetti a un repository: Artifact Registry Writer (roles/artifactregistry.writer)
• Elimina i pacchetti: Amministratore del repository Artifact Registry (roles/artifactregistry.repoAdmin)

Per saperne di più sulla concessione dei ruoli, consulta Gestire l'accesso a progetti, cartelle e organizzazioni.

Potresti anche riuscire a ottenere le autorizzazioni richieste tramite i ruoli personalizzati o altri ruoli predefiniti.

Ottenere un token di accesso

I token di accesso sono validi per 60 minuti. Genera un token di accesso poco prima di eseguire comandi che interagiscono con i repository.

Per ottenere un token, utilizza una delle seguenti opzioni:

• Utilizza il comando npx per aggiornare il token di accesso.

  1. Assicurati che le credenziali per la connessione al registry npm pubblico siano nel file di configurazione npm dell'utente, ~/.npmrc.

  2. Esegui il seguente comando nella directory del progetto Node.js.

     npx google-artifactregistry-auth
     

     Se il repository Artifact Registry è impostato come registry globale e i pacchetti non sono definiti, utilizza il seguente comando in modo che possa scaricare l'helper delle credenziali dal registry npm pubblico anziché dal repository Artifact Registry.

     npm_config_registry=https://registry.npmjs.org npx google-artifactregistry-auth
     

• Aggiungi uno script al file package.json del progetto.

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

  Esegui lo script nella directory del progetto Node.js.

  npm run artifactregistry-login
  

Artifact Registry legge le impostazioni del repository di Artifact Registry nel file .npmrc del progetto e le utilizza per aggiungere le credenziali del token al file .npmrc dell'utente. La memorizzazione del token nel file .npmrc dell'utente isola le tue credenziali dal codice sorgente e dal sistema di controllo del codice sorgente.

Aggiunta di pacchetti

Modalità del repository: standard

Puoi pubblicare una versione specifica di un pacchetto una sola volta. Si tratta di una limitazione di npm per garantire che i contenuti di una versione del pacchetto pubblicata siano sempre gli stessi. Di conseguenza, non puoi:

• Sostituire una versione del pacchetto ripubblicandola nel repository
• Rimuovi un pacchetto o la relativa versione dal repository e poi pubblica un pacchetto con lo stesso nome e numero di versione

Se non specifichi un tag quando pubblichi un pacchetto, npm aggiunge il tag latest. Per semplificare l'installazione dei pacchetti in una fase di sviluppo specifica, valuta la possibilità di pubblicarli con un tag, ad esempio beta o dev.

Artifact Registry applica nomi di pacchetti alfanumerici minuscoli per i pacchetti npm.

Per aggiungere un pacchetto:

1. Assicurati che il nome del pacchetto in package.json includa l'ambito configurato per il tuo repository. L'esempio seguente mostra un pacchetto con l'ambito dev-repo.

   "name": "@dev-repo/my-package"
   

2. Se utilizzi lo strumento di assistenza per le credenziali per autenticarti con un token di accesso, ottieni un nuovo token.

3. Aggiungi i pacchetti al repository. Puoi utilizzare un comando npm o yarn.

   Per taggare il pacchetto, includi il flag --tag e sostituisci TAG con il tag che vuoi utilizzare. Se non includi il flag --tag, npm imposta automaticamente il tag su latest.

   npm publish --tag=TAG
   

   yarn publish --tag TAG
   

Visualizzazione di pacchetti e versioni

Modalità del repository: standard, remoto, virtuale

Per ottenere le informazioni sul pacco con npm o yarn:

1. Se utilizzi lo strumento di assistenza per le credenziali per autenticarti con un token di accesso, ottieni un nuovo token.

2. Esegui il comando appropriato:

   npm view
   

   yarn info
   

Per visualizzare i pacchetti e le relative versioni utilizzando la console Google Cloud o gcloud:

Console

1. Apri la pagina Repositori nella console Google Cloud.

   Apri la pagina Repositori

2. Nell'elenco dei repository, fai clic sul repository appropriato.

   La pagina Pacchetti elenca i pacchetti nel repository.

3. Fai clic su un pacchetto per visualizzarne le versioni.

gcloud

Per elencare i pacchetti in un repository, esegui il comando seguente:

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

Sostituisci quanto segue:

• REPOSITORY è il nome del repository. Se hai configurato un repository predefinito, puoi omettere questo flag per utilizzare quello predefinito.
• LOCATION è la posizione regionale o multiregionale del repository. Se hai configurato una località predefinita, puoi omettere questo flag per utilizzare quella predefinita.

Per visualizzare le versioni di un pacchetto, esegui questo comando:

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

Sostituisci quanto segue:

• PACKAGE è l'ID del pacchetto o l'identificatore completamente qualificato del pacchetto.
• REPOSITORY è il nome del repository. Se hai configurato un repository predefinito, puoi omettere questo flag per utilizzare quello predefinito.
• LOCATION è la posizione regionale o multiregionale del repository. Utilizza questo flag per visualizzare i repository in una posizione specifica. Se hai configurato una località predefinita, puoi omettere questo flag per utilizzare quella predefinita.

La visualizzazione di pacchetti e versioni dalla console Google Cloud o dall'interfaccia a riga di comando gcloud è disponibile solo per i repository standard e remoti.

Per i repository remoti, l'elenco restituito deve includere tutte le dipendenze dirette e trascendenti memorizzate nella cache nel repository.

File della scheda

Modalità del repository: standard, remoto

Puoi elencare i file in un repository, i file in tutte le versioni di un pacchetto specificato o i file in una versione specifica di un pacchetto.

Per tutti i comandi seguenti, puoi impostare un numero massimo di file da restituire aggiungendo il flag --limit al comando.

Per elencare tutti i file nel progetto, nel repository e nella località predefiniti quando i valori predefiniti sono configurati:

gcloud artifacts files list

Per elencare i file in un progetto, un repository e una posizione specificati, esegui il comando:

gcloud artifacts files list \
    --project=PROJECT \
    --repository=REPOSITORY \
    --location=LOCATION

Per elencare i file di tutte le versioni di un pacchetto specifico:

gcloud artifacts files list \
    --project=PROJECT \
    --repository=REPOSITORY \
    --location=LOCATION \
    --package=PACKAGE

Per elencare i file di una versione specifica del pacchetto:

gcloud artifacts files list \
    --project=PROJECT \
    --repository=REPOSITORY \
    --location=LOCATION \
    --package=PACKAGE \
    --version=VERSION

Per elencare i file per un tag specifico:

gcloud artifacts files list \
    --project=PROJECT \
    --repository=REPOSITORY \
    --location=LOCATION \
    --package=PACKAGE \
    --tag=TAG

Sostituisci i seguenti valori:

• LOCATION: la località regionale o multiregionale del repository.
• PROJECT: il tuo Google Cloud ID progetto. Se l'ID progetto contiene due punti (:), consulta Progetti basati sul dominio.
• REPOSITORY: il nome del repository in cui è memorizzata l'immagine.
• PACKAGE: il nome del pacchetto.
• VERSION: la versione del pacchetto.
• TAG: il tag associato al pacchetto.

Esempi

Prendi in considerazione le seguenti informazioni sul pacchetto:

• Progetto: my-project
• Repository: my-repo
• Posizione del repository: us-west1
• Pacchetto: my-app

Il seguente comando elenca tutti i file nel repository my-repo nella posizione us-west1 all'interno del progetto predefinito:

gcloud artifacts files list \
    --location=us-west1 \
    --repository=my-repo

Il seguente comando elenca i file nella versione 1.0 del pacchetto.

gcloud artifacts files list \
    --project=my-project \
    --location=us-west1 \
    --repository=my-repo \
    --package=my-app \
    --version=1.0

Il seguente comando elenca i file nella versione del pacchetto con il tag 1.0-dev

gcloud artifacts files list \
    --project=my-project \
    --location=us-west1 \
    --repository=my-repo \
    --package=my-app \
    --tag=1.0-dev

Pacchetti di tagging

Modalità del repository: standard

Puoi visualizzare, aggiungere, aggiornare ed eliminare i tag. I tag possono aiutarti a gestire le versioni semantiche dei pacchetti e semplificare l'installazione dei pacchetti in una fase specifica di sviluppo.

Ad esempio, puoi taggare la build release candidate corrente con rc. Il tuo team potrà quindi installare la versione corretta in base al tag anziché a un specificatore di versione e la mancata pubblicazione delle versioni pre-release inutilizzate non interromperà le dipendenze dal pacchetto release candidate.

Visualizzazione dei tag

Per visualizzare i tag di un pacchetto:

Console

1. Apri la pagina Repositori nella console Google Cloud.

   Apri la pagina Repositori

2. Fai clic sul pacchetto per visualizzare le versioni e i tag associati.

3. Seleziona la versione del pacchetto da taggare.

4. Nella riga della versione selezionata, fai clic su Altre azioni () e poi su Modifica tag.

5. Digita i nuovi tag nel campo e poi fai clic su SALVA.

gcloud

Esegui il comando:

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

Dove

• PACKAGE è il nome del pacchetto nel repository.
• REPOSITORY è il nome del repository. Se hai configurato un repository predefinito, puoi omettere questo flag per utilizzare quello predefinito.
• LOCATION è una località regionale o multiregionale. Utilizza questo flag per visualizzare i repository in una posizione specifica. Se hai configurato una posizione predefinita, puoi omettere questo flag per utilizzare quella predefinita.

Ad esempio, per visualizzare i tag per il pacchetto my-package nel repositorymy-repo nella posizione predefinita, esegui il comando:

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

Creazione di tag

Puoi creare un tag per una versione specifica di un pacchetto.

Per taggare un'immagine esistente in un repository:

Console

1. Apri la pagina Repositori nella console Google Cloud.

   Apri la pagina Repositori

2. Fai clic sul pacchetto per visualizzarne le versioni.

3. Seleziona la versione del pacchetto da taggare.

4. Nella riga della versione selezionata, fai clic su Altre azioni () e poi su Modifica tag.

5. Digita i nuovi tag nel campo e poi fai clic su SALVA.

gcloud

Esegui questo comando:

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

Dove

• TAG è il tag da applicare al pacchetto.
• PACKAGE è il nome del pacchetto nel repository.
• VERSION è la versione del pacchetto che vuoi taggare.
• LOCATION è una località regionale o multiregionale. Utilizza questo flag per visualizzare i repository in una posizione specifica. Se hai configurato una posizione predefinita, puoi omettere questo flag per utilizzare quella predefinita.
• REPOSITORY è il nome del repository. Se hai configurato un repository predefinito, puoi omettere questo flag per utilizzare quello predefinito.

Ad esempio, per creare il tag release-candidate per la versione 1.0.0 del pacchetto my-package nel repository my-repo nella posizione predefinita, esegui il comando:

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

Aggiornamento dei tag

Puoi modificare un tag associato a una versione del pacchetto.

Per modificare un tag esistente:

Console

1. Apri la pagina Repositori nella console Google Cloud.

   Apri la pagina Repositori

2. Fai clic sul pacchetto per visualizzarne le versioni.

3. Seleziona la versione del pacchetto con il tag da modificare.

4. Nella riga della versione selezionata, fai clic su Altre azioni () e poi su Modifica tag.

5. Modifica il tag e poi fai clic su SALVA.

gcloud

Esegui questo comando:

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

Dove

• TAG è il tag da applicare al pacchetto.
• PACKAGE è il nome del pacchetto nel repository.
• VERSION è la versione del pacchetto che vuoi taggare.
• LOCATION è una località regionale o multiregionale. Utilizza questo flag per visualizzare i repository in una posizione specifica. Se hai configurato una posizione predefinita, puoi omettere questo flag per utilizzare quella predefinita.
• REPOSITORY è il nome del repository. Se hai configurato un repository predefinito, puoi omettere questo flag per utilizzare quello predefinito.

Ad esempio, per modificare il tag della versione 1.0.0 del pacchetto my-package in production nel repository my-repo nella posizione predefinita, esegui il comando:

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

Annullamento del tagging delle versioni del pacchetto

Puoi rimuovere un tag esistente da una versione del pacchetto.

Per rimuovere un tag:

Console

1. Apri la pagina Repositori nella console Google Cloud.

   Apri la pagina Repositori

2. Fai clic sull'immagine per visualizzarne le versioni.

3. Seleziona la versione dell'immagine da annullare il tagging.

4. Nella riga della versione selezionata, fai clic su Altre azioni () e poi su Modifica tag.

5. Elimina il tag e fai clic su SALVA.

gcloud

Esegui questo comando:

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

Dove

• TAG è il tag da applicare al pacchetto.
• PACKAGE è il nome del pacchetto nel repository.
• LOCATION è una località regionale o multiregionale. Utilizza questo flag per visualizzare i repository in una posizione specifica. Se hai configurato una posizione predefinita, puoi omettere questo flag per utilizzare quella predefinita.
• REPOSITORY è il nome del repository. Se hai configurato un repository predefinito, puoi omettere questo flag per utilizzare quello predefinito.

Ad esempio, per rimuovere il tag release-candidate dal pacchetto my-package nel repository my-repo nella posizione predefinita, esegui il comando:

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

Installazione dei pacchetti

Modalità del repository: standard, remoto, virtuale

Per installare un pacchetto dal repository dei pacchetti Node.js:

1. Se utilizzi lo strumento di assistenza per le credenziali per autenticarti con un token di accesso, ottieni un nuovo token.

2. Utilizza il comando npm install o yarn add.

   npm

   Per installare la versione con il tag latest:

   npm install @SCOPE/PACKAGE
   

   Per installare la versione con un tag diverso:

   npm install @SCOPE/PACKAGE@TAG
   

   Per installare una versione specifica:

   npm install @SCOPE/PACKAGE@VERSION
   

   filato

   Per installare la versione con il tag latest:

   yarn add @SCOPE/PACKAGE
   

   Per installare la versione con un tag diverso:

   yarn add @SCOPE/PACKAGE@TAG
   

   Per installare una versione specifica:

   yarn add @SCOPE/PACKAGE@VERSION
   

   Sostituisci i seguenti valori:

   • SCOPE è l'ambito associato al repository. Se il repository dei pacchetti Node.js non è configurato con un ambito, ometti @SCOPE/ dal comando.
   • PACKAGE è il nome del pacchetto nel repository.
   • TAG è il tag della versione che vuoi installare.
   • VERSION è il numero di versione che vuoi installare.

Quando specifichi un pacchetto come dipendenza in package.json, assicurati di includere l'ambito del repository. L'esempio seguente mostra l'ambito @dev-repo per un pacchetto denominato my-package.

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

Per i repository standard, scarichi un pacchetto direttamente dal repository.

Per un repository remoto, scarichi una copia memorizzata nella cache del pacchetto e delle sue dipendenze. Se non esiste una copia memorizzata nella cache, il repository remoto scarica il pacchetto dall'origine upstream e lo memorizza nella cache prima di fornirtelo. Puoi verificare che il repository remoto abbia recuperato i pacchetti dall'origine upstream visualizzando l'elenco dei pacchetti nel repository.

Per un repository virtuale, Artifact Registry cerca il pacchetto richiesto nei repository upstream.

• I repository remoti upstream scaricheranno e memorizzeranno nella cache il pacchetto richiesto se non esiste una copia memorizzata nella cache. I repository virtuali pubblicano solo i pacchetti richiesti, non li archiviano.
• Se richiedi una versione disponibile in più di un repository upstream, Artifact Registry sceglie un repository upstream da utilizzare in base alle impostazioni di priorità configurate per il repository virtuale.

Ad esempio, considera un repository virtuale con le seguenti impostazioni di priorità per i repository upstream:

• main-repo: priorità impostata su 100
• secondary-repo1: priorità impostata su 80.
• secondary-repo2: priorità impostata su 80.
• test-repo: priorità impostata su 20.

main-repo ha il valore di priorità più alto, quindi il repository virtuale lo cerca sempre per primo.

Sia secondary-repo1 che secondary-repo2 hanno la priorità impostata su 80. Se un pacchetto richiesto non è disponibile in main-repo, Artifact Registry esamina questi repository. Poiché hanno entrambi lo stesso valore di priorità, Artifact Registry può scegliere di pubblicare un pacchetto da uno dei due repository se la versione è disponibile in entrambi.

test-repo ha il valore di priorità più basso e pubblicherà un elemento archiviato se nessuno degli altri repository a monte lo ha.

Eliminazione dei pacchetti

Modalità del repository: standard, remoto

Puoi eliminare un pacchetto e tutte le sue versioni oppure una versione specifica.

• Una volta eliminato un pacchetto, non puoi annullare l'azione.
• Per i repository remoti, viene eliminata solo la copia memorizzata nella cache del pacchetto. L'origine in upstream non è interessata. Se elimini un pacchetto memorizzato nella cache, Artifact Registry lo scaricherà e lo memorizzerà di nuovo nella cache la prossima volta che il repository riceverà una richiesta per la stessa versione del pacchetto.

Una volta pubblicata una versione del pacchetto, non puoi ripubblicare un pacchetto con la stessa combinazione di nome e versione, anche dopo aver eliminato la versione. Si tratta di una limitazione npm per garantire che i contenuti di una versione del pacchetto pubblicata siano sempre gli stessi.

Se vuoi incoraggiare gli utenti a installare una versione aggiornata del pacchetto, utilizza il comando npm deprecate per contrassegnare la vecchia versione del pacchetto come deprecata. Quando un utente tenta di installare il pacchetto ritirato, Artifact Registry restituisce un avviso di ritiro.

Prima di eliminare un pacchetto o una versione del pacchetto, verifica di aver comunicato o risolto eventuali dipendenze importanti.

Per eliminare un pacchetto:

Console

1. Apri la pagina Repositori nella console Google Cloud.

   Apri la pagina Repositori

2. Nell'elenco dei repository, fai clic sul repository appropriato.

   La pagina Pacchetti elenca i pacchetti nel repository.

3. Seleziona il pacchetto da eliminare.

4. Fai clic su ELIMINA.

5. Nella finestra di dialogo di conferma, fai clic su ELIMINA.

gcloud

Esegui questo comando:

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

Sostituisci quanto segue:

• PACKAGE è il nome del pacchetto nel repository.
• REPOSITORY è il nome del repository. Se hai configurato un repository predefinito, puoi omettere questo flag per utilizzare quello predefinito.
• LOCATION è la posizione regionale o multiregionale del repository. Utilizza questo flag per visualizzare i repository in una posizione specifica. Se hai configurato una località predefinita, puoi omettere questo flag per utilizzare quella predefinita.

Il flag --async fa sì che il comando ritorni immediatamente, senza attendere il completamento dell'operazione in corso.

Per eliminare le versioni di un pacchetto:

Console

1. Apri la pagina Repositori nella console Google Cloud.

   Apri la pagina Repositori

2. Nell'elenco dei repository, fai clic sul repository appropriato.

   La pagina Pacchetti elenca i pacchetti nel repository.

3. Fai clic su un pacchetto per visualizzarne le versioni.

4. Seleziona le versioni da eliminare.

5. Fai clic su ELIMINA.

6. Nella finestra di dialogo di conferma, fai clic su ELIMINA.

gcloud

Esegui questo comando:

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

Sostituisci quanto segue:

• VERSION è il nome della versione da eliminare.
• PACKAGE è il nome del pacchetto nel repository.
• REPOSITORY è il nome del repository. Se hai configurato un repository predefinito, puoi omettere questo flag per utilizzare quello predefinito.
• LOCATION è la posizione regionale o multiregionale del repository. Utilizza questo flag per visualizzare i repository in una posizione specifica. Se hai configurato una località predefinita, puoi omettere questo flag per utilizzare quella predefinita.

Il flag --async fa sì che il comando ritorni immediatamente, senza attendere il completamento dell'operazione in corso.

Passaggi successivi

• Scopri di più sulla gestione dei pacchetti Maven
• Scopri di più sulla gestione delle immagini container
• Scaricare singoli file all'interno di un pacchetto