Store Java packages in Artifact Registry

This quickstart shows you how to set up a private Artifact Registry Maven repository and upload a package to it.

To follow step-by-step guidance for this task directly in the Google Cloud console, click Guide me:

Before you begin

Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
Create a project: To create a project, you need the Project Creator (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Artifact Registry API.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the API

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
Create a project: To create a project, you need the Project Creator (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Artifact Registry API.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the API

Launch Cloud Shell

In this quickstart, you will use Cloud Shell, which is a shell environment for managing resources hosted on Google Cloud.

Cloud Shell comes preinstalled with the Google Cloud CLI and Java. The gcloud CLI provides the primary command-line interface for Google Cloud.

Launch Cloud Shell:

Go to Google Cloud console.

Google Cloud console
On the Google Cloud console toolbar, click Activate Cloud Shell:

A Cloud Shell session opens inside a frame lower on the console. You use this shell to run gcloud commands.

Create a Java package repository

Create the repository for your Java artifacts.

Create the repository:

Console

Open the Repositories page in the Google Cloud console.

Open the Repositories page
Click Create Repository.
Specify quickstart-java-repo as the repository name.
Choose Maven as the format and Standard as the mode.
Under Location Type, select Region and then choose the location us-central1.
Click Create.

The repository is added to the repository list.

gcloud

Run the following command to create a new Java package repository in the current project named quickstart-java-repo in the location us-central1.

gcloud artifacts repositories create quickstart-java-repo --repository-format=maven \
--location=us-central1 --description="Java package repository"

Run the following command to verify that your repository was created:
```
gcloud artifacts repositories list
```
For more information about Artifact Registry commands, run the command gcloud artifacts.

Configure Maven

Choose a simple Maven project that you want to use.

If you don't have a simple project available, you can create the Maven in 5 minutes project.

This quickstart assumes that your simple project does not have additional parent or plugin dependencies stored in Artifact Registry. For details about configuring a Maven project with dependencies in Artifact Registry, see Authenticating with a credential helper.
To simplify gcloud commands, set the default repository to quickstart-java-repo and the default location to us-central1. After the values are set, you do not need to specify them in gcloud commands that require a repository or a location.

To set the repository, run the command:
```
gcloud config set artifacts/repository quickstart-java-repo
```
To set the location, run the command:
```
gcloud config set artifacts/location us-central1
```
For more information about these commands, see the gcloud config set documentation.

Run the following command to print the settings for the default quickstart-java-repo repository.

gcloud artifacts print-settings mvn

The output of the gcloud command looks like the following snippet, where PROJECT is your project ID.

<distributionManagement>
  <snapshotRepository>
    <id>artifact-registry</id>
    <url>artifactregistry://us-central1-maven.pkg.dev/PROJECT/quickstart-java-repo</url>
  </snapshotRepository>
  <repository>
    <id>artifact-registry</id>
    <url>artifactregistry://us-central1-maven.pkg.dev/PROJECT/quickstart-java-repo</url>
  </repository>
</distributionManagement>

<repositories>
  <repository>
    <id>artifact-registry</id>
    <url>artifactregistry://us-central1-maven.pkg.dev/PROJECT/quickstart-java-repo</url>
    <releases>
      <enabled>true</enabled>
    </releases>
    <snapshots>
      <enabled>true</enabled>
    </snapshots>
  </repository>
</repositories>

<build>
  <extensions>
    <extension>
      <groupId>com.google.cloud.artifactregistry</groupId>
      <artifactId>artifactregistry-maven-wagon</artifactId>
      <version>2.2.5</version>
    </extension>
  </extensions>
</build>

Add the settings to the pom.xml file for your Maven project. The following outline shows the relative placement of each main element. See the Maven POM reference for details about the structure of the file.

<project xmlns="http://maven.apache.org/POM/4.0.0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
                      http://maven.apache.org/xsd/maven-4.0.0.xsd">

  <!-- Build Settings -->
  <build>
    ...
    <extensions>...</extensions>
  </build>

  <!-- Environment Settings -->
  <repositories>...</repositories>
  <distributionManagement>...</distributionManagement>
</project>

Your Maven project can now upload packages to your repository.

Configure Gradle

Create a simple Gradle project to deploy a package to the Artifact Registry repository you created. If you don't have a test Gradle build, you can follow the introductory Gradle tutorial to create a simple Gradle build.

To simplify gcloud commands, set the default repository to quickstart-java-repo and the default location to us-central1. After the values are set, you do not need to specify them in gcloud commands that require a repository or a location.

To set the repository, run the command:

gcloud config set artifacts/repository quickstart-java-repo

To set the location, run the command:

gcloud config set artifacts/location us-central1

For more information about these commands, see the gcloud config set documentation.

Add settings to connect the repository to the build.gradle file. The following command prints settings to add for the default quickstart-java-repo repository.

gcloud artifacts print-settings gradle

The output of the gcloud command looks like the following example, where PROJECT is your project ID.

plugins {
  id "maven-publish"
  id "com.google.cloud.artifactregistry.gradle-plugin" version "2.2.5"
      }

publishing {
  repositories {
    maven {
      url "artifactregistry://us-central1-maven.pkg.dev/PROJECT/quickstart-java-repo"
    }
  }
}

repositories {
  maven {
    url "artifactregistry://us-central1-maven.pkg.dev/PROJECT/quickstart-java-repo"
  }
}

Verify that the build.gradle file includes a publications section. If it does not, add it to your build.gradle file.

The publications section is a child of publishing as shown in the following example:
```
publishing {
  publications {
       mavenJava(MavenPublication) {
          groupId  'maven.example.id'
          from components.java
       }
  }
  repositories {
    maven {
      url "artifactregistry://us-central1-maven.pkg.dev/PROJECT/quickstart-java-repo"
    }
  }
}
```
You can also add repository configuration to your init.gradle or settings files. For details about these options, see Setting up authentication.

Upload a package to the repository

For Maven, you can use mvn deploy and mvn release to add packages to the repository.

Note: The mvn archetype command is not supported if used exclusively from the Artifact Registry repository.

For Gradle, use the gradle publish command to upload a package to the repository.
View the package in the repository
To verify that your package was added to the repository:
Console
1. Open the Repositories page in the Google Cloud console.
  
  Open the Repositories page
2. In the repository list, click the quickstart-java-repo repository.
  
  The Packages page lists the packages in the repository.
gcloud
1. To list the packages in the quickstart-java-repo repository, run the following command:
  gcloud artifacts packages list --repository=quickstart-java-repo
  The output will be similar to the following:
  Listing items under project <project-id>, location us-central1,\ repository quickstart-java-repo. PACKAGE: maven.example.id:gradle-demo CREATE_TIME: 2022-01-20T22:46:07 UPDATE_TIME: 2022-01-20T22:46:07
  Where maven.example.id:gradle-demo is the package ID
  
  To view versions for a package, run the following command:
  gcloud artifacts versions list --package=PACKAGE
  Where PACKAGE is the package ID.

Clean up

To avoid incurring charges to your Google Cloud account for the resources used on this page, follow these steps.

Before you remove the repository, ensure that any packages you want to keep are available in another location.

To delete the repository:

Console

Open the Repositories page in the Google Cloud console.

Open the Repositories page
In the repository list, select the quickstart-java-repo repository.
Click Delete.

gcloud

To delete the quickstart-java-repo repository, run the following command:
```
gcloud artifacts repositories delete quickstart-java-repo
```
If you want to remove the default repository and location settings that you configured for the active gcloud configuration, run the following commands:
```
gcloud config unset artifacts/repository
gcloud config unset artifacts/location
```

What's next

Learn more about configuring authentication
Learn about managing repositories
Learn about managing packages
Read our resources about DevOps and explore our research program.

Store Java packages in Artifact Registry

Before you begin

Launch Cloud Shell

Create a Java package repository

Console

gcloud

Configure Maven

Configure Gradle

Upload a package to the repository

View the package in the repository

Console

gcloud

Clean up

Console

gcloud

What's next