Store Java packages in Artifact Registry

Launch Cloud Shell

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:

1. Go to Google Cloud console.

   Google Cloud console

2. 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

1. Create the repository:

Configure Maven

1. 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.

2. 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.

3. 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.3</version>
       </extension>
     </extensions>
   </build>
   

4. 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

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.

1. 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.3"
         }
   
   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"
     }
   }
   

2. 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.

   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.