gem-artifact-registry-npm

Activate Cloud Shell

Cloud Shell is a virtual machine that is loaded with development tools. It offers a persistent 5GB home directory and runs on the Google Cloud. Cloud Shell provides command-line access to your Google Cloud resources.

1. Click Activate Cloud Shell at the top of the Google Cloud console.

When you are connected, you are already authenticated, and the project is set to your PROJECT_ID. The output contains a line that declares the PROJECT_ID for this session:

Your Cloud Platform project in this session is set to YOUR_PROJECT_ID

gcloud is the command-line tool for Google Cloud. It comes pre-installed on Cloud Shell and supports tab-completion.

2. (Optional) You can list the active account name with this command:

gcloud auth list

3. Click Authorize.

4. Your output should now look like this:

Output:

ACTIVE: * ACCOUNT: student-01-xxxxxxxxxxxx@qwiklabs.net To set the active account, run: $ gcloud config set account `ACCOUNT`

5. (Optional) You can list the project ID with this command:

gcloud config list project

Output:

[core] project = <project_ID>

Example output:

[core] project = qwiklabs-gcp-44776a13dea667a6 Note: For full documentation of gcloud, in Google Cloud, refer to the gcloud CLI overview guide.

Overview

In this lab, you'll learn how to create an NPM Artifact Registry in Google Cloud and upload a simple Node.js package to it. This lab assumes you have basic familiarity with Google Cloud and NPM package management. You will create an Artifact Registry repository for NPM packages, configure your local environment to authenticate with Artifact Registry, create a sample NPM package, and then publish that package to your newly created repository.

Task 1. Create an NPM Artifact Registry Repository

First, you'll create a new Artifact Registry repository specifically for storing NPM packages.

1. Enable the Artifact Registry API. If you haven't already enabled the Artifact Registry API in your project, you can do so using the following command:

gcloud services enable artifactregistry.googleapis.com Note:
This command enables the Artifact Registry API.

2. Set your Project ID:

gcloud config set project {{{ project_0.project_id | "PROJECT_ID" }}} Note:
This command sets your active project identity.

3. Set your default region to

gcloud config set compute/region {{{ project_0.default_region | "REGION" }}} Note:
This command sets your active compute region.

4. Create a new NPM repository in Artifact Registry. Replace my-npm-repo with your desired repository name.

gcloud artifacts repositories create my-npm-repo \ --repository-format=npm \ --location={{{ project_0.default_region | "REGION" }}} \ --description="NPM repository" Note:
Apply my-npm-repo as a unique name for your repository.

Task 2. Create and Publish an NPM Package

Now, you'll create a simple NPM package to publish to Artifact Registry repository.

1. Create a new directory for your package and navigate into it:

mkdir my-npm-package cd my-npm-package Note:
Creates a directory named my-npm-package

2. Initialize a new NPM package. Ensure the package name is unique (e.g. preferably prefixed with your project ID for namespacing) and :

npm init --scope=@{{{ project_0.project_id | "PROJECT_ID" }}} -y Note:
Initializes an npm package with a scope

3. Create a simple index.js file:

echo 'console.log(`Hello from my-npm-package!`);' > index.js Note:
Creates a basic index.js file

Task 3. Configure NPM to Authenticate with Artifact Registry

Next, configure NPM to authenticate with your Artifact Registry repository. This allows you to publish and install packages.

1. Create Artifact settings in your .npmrc file (if it does not exist create it). Note that this step generates the .npmrc file.

gcloud artifacts print-settings npm \ --project={{{ project_0.project_id | "PROJECT_ID" }}} \ --repository=my-npm-repo \ --location={{{ project_0.default_region | "REGION" }}} \ --scope=@{{{ project_0.project_id | "PROJECT_ID" }}} > ./.npmrc Note:
This command prints configuration settings for npm and adds a scope. Use this command to generate the formatting required in the `.npmrc` to avoid formatting issues.

2. Authenticate to Artifact Registry. Run the following command to authenticate:

gcloud auth configure-docker {{{ project_0.default_region | "REGION" }}}-npm.pkg.dev Note:
This command configures Docker to authenticate with Artifact Registry.

3. Update the package.json file to authenticate to Artifact Registry

{ "name": "@qwiklabs-gcp-00-e9159952f381/my-npm-package", "version": "1.0.0", "description": "", "main": "index.js", "scripts": { "artifactregistry-login": "npx google-artifactregistry-auth --repo-config=./.npmrc --credential-config=./.npmrc", "test": "echo \"Error: no test specified\" && exit 1" }, "keywords": [], "author": "", "license": "ISC", "type": "commonjs" } Note:
Add the artifactregistry-login script into the package.json

4. Refresh the authentication token by calling the artifactregisty-login

npm run artifactregistry-login Note:
The artifactregistry-login script command will use your active gcloud login to fetch a short-lived access token and insert it into your .npmrc file.

5. View the .npmrc file to view the authentication token is added

cat .npmrc Note:
A fresh authentication token has been added to the .npmrc file.

6. Publish the package to Artifact Registry. Replace my-npm-repo with your repository name:

npm publish --registry=https://{{{ project_0.default_region | "REGION" }}}-npm.pkg.dev/{{{ project_0.project_id | "PROJECT_ID" }}}/my-npm-repo/ Note:
The package has been published to the specified Artifact Registry repository.

Task 4. Verify Package Upload

Confirm the package has been successfully uploaded to artifact registry

1. Navigate to Artifact Registry in the Google Cloud Console.

gcloud artifacts packages list --repository=my-npm-repo --location={{{ project_0.default_region | "REGION" }}} Note:
This command lists NPM packages in the Artifact Registry. You can verify that your package exists.

2. Verify that your package is listed in the Artifact Registry repository.

PACKAGE: @{{{ project_0.project_id | "PROJECT_ID" }}} CREATE_TIME: 2025-06-25T04:20:04 UPDATE_TIME: 2025-06-25T04:20:04 ANNOTATIONS: Note:
This command lists packages in the Artifact Registry. You can verify that your package exists.

Congratulations!

You have successfully created an NPM Artifact Registry repository and published an NPM package to it. This allows you to manage and share your private NPM packages within your Google Cloud project. Remember to manage access to your repository appropriately to control who can publish and consume packages.

Additional Resources

• Artifact Registry Documentation

• NPM Documentation

Manual Last Updated Jun 24, 2025

Lab Last Tested Jun 24, 2025