Managing Java packages

This page describes adding, viewing, and deleting Java packages and package versions.

If you want to use sbt as a build tool for Scala and Java instead of using Maven or Gradle, there is a community-created sbt plugin available. This documentation does not describe configuration or usage of Scala clients.

Before you begin

1. If the target repository does not exist, create a new repository.
2. Verify that you have the required permissions for the repository.
3. Verify that you have configured authentication. If you are using an access token, make sure that you refresh the token before connecting to the repository.
4. (Optional) Configure defaults for gcloud commands.

Adding packages

To add packages to the repository:

Maven

Use mvn deploy and mvn release to add packages to the repository.

To successfully deploy a Maven project that references a parent, the project must include the Artifact Registry Wagon provider in a core extensions file as described in the authentication instructions.

Use mvn deploy:deploy-file to upload artifacts that were built outside of Maven.

For example, this example command deploys example/external.jar and its project file example/pom.xml to the repository us-central1-maven.pkg.dev/my-project/my-repo

mvn deploy:deploy-file \
-Durl=artifactregistry://us-central1-maven.pkg.dev/my-project/my-repo \
-DpomFile=example/pom.xml -Dfile=example/external.jar

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

To configure integration with Cloud Build, see Integrating with Cloud Build.

Gradle

To successfully publish to the repository, your build.gradle file must include a publications section that defines files to upload.

Use the gradle publish command to upload a package to the repository.

Viewing packages and versions

To view packages and package versions using the Google Cloud console or gcloud:

Console

1. Open the Repositories page in the Google Cloud console.

   Open the Repositories page

2. In the repository list, click the appropriate repository.

   The Packages page lists the packages in the repository.

3. Click a package to view versions of the package.

gcloud

To list packages in a repository, run the following command:

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

Where

• REPOSITORY is the name of the repository. If you configured a default repository, you can omit this flag to use the default.
• LOCATION is a regional or multi-regional location. Use this flag to view repositories in a specific location. If you configured a default location, you can omit this flag to use the default.

To view versions of a package, run the following command:

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

Where

• PACKAGE is the ID of the package or fully qualified identifier for the package.
• REPOSITORY is the name of the repository. If you configured a default repository, you can omit this flag to use the default.
• LOCATION is a regional or multi-regional location. Use this flag to view repositories in a specific location. If you configured a default location, you can omit this flag to use the default.

Some packages might include multiple WAR or JAR files. To list all files in a repository, run the following command:

gcloud auth login
curl -v -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "X-GFE-SSL: yes" \
https://artifactregistry.googleapis.com/v1beta2/projects/PROJECT/locations/LOCATION/repositories/REPOSITORY/files

Replace the following values:

• PROJECT is the project ID.
• LOCATION is a regional or multi-regional location. Use this flag to view repositories in a specific location. If you configured a default location, you can omit this flag to use the default.
• REPOSITORY is the name of the repository. If you configured a default repository, you can omit this flag to use the default.

Listing files

You can list files in a repository, files in all versions of a specified package, or files in a specific version of a package.

For all the following commands, you can set a maximum number of files to return by adding the --limit flag to the command.

To list all files in the default project, repository, and location when the default values are configured:

gcloud artifacts files list

To list files in a specified project, repository, and location, run the command:

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

To list files for all versions of a specific package:

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

To list files for a specific package version:

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

Replace the following values:

• LOCATION is the regional or multi-regional location of the repository.
• PROJECT is your Google Cloud project ID. If your project ID contains a colon (:), see Domain-scoped projects.
• REPOSITORY is the name of the repository where the image is stored.
• PACKAGE is the name of the package.
• VERSION is the version of the package.

Examples

Consider the following package information:

• Project: my-project
• Repository: my-repo
• Repository location: us-central1
• Package: my-app

The following command lists all files in the repository my-repo in the location us-central1 within the default project:

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

The following command lists files in version 1.0 of the package.

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

Deleting packages and versions

Before you delete a package or package version, verify that any you have communicated or addressed any important dependencies on it.

To delete a package:

Console

1. Open the Repositories page in the Google Cloud console.

   Open the Repositories page

2. In the repository list, click the appropriate repository.

   The Packages page lists the packages in the repository.

3. Select the package that you want to delete.

4. Click DELETE.

5. In the confirmation dialog box, click DELETE.

gcloud

Run the following command:

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

Where

• PACKAGE is the name of the package in the repository.
• REPOSITORY is the name of the repository. If you configured a default repository, you can omit this flag to use the default.
• LOCATION is a regional or multi-regional location. Use this flag to view repositories in a specific location. If you configured a default location, you can omit this flag to use the default.
• --async Return immediately, without waiting for the operation in progress to complete.

To delete versions of a package:

Console

1. Open the Repositories page in the Google Cloud console.

   Open the Repositories page

2. In the repository list, click the appropriate repository.

   The Packages page lists the packages in the repository.

3. Click a package to view versions of that package.

4. Select versions that you want to delete.

5. Click DELETE.

6. In the confirmation dialog box, click DELETE.

gcloud

Run the following command:

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

Where

• PACKAGE is the name of the package in the repository.
• REPOSITORY is the name of the repository. If you configured a default repository, you can omit this flag to use the default.
• LOCATION is a regional or multi-regional location. Use this flag to view repositories in a specific location. If you configured a default location, you can omit this flag to use the default.
• --async returns immediately, without waiting for the operation in progress to complete.

Downloading packages

To download an artifact as a part of your build, you declare the artifact as a dependency.

Maven

Declare the packages you want to download in the project pom.xml file. The following example declares version 1.0 of the package artifact as a dependency.

<dependencies>
    <dependency>
        <groupId>group</groupId>
        <artifactId>artifact</artifactId>
        <version>1.0</version>
    </dependency>
<dependencies>

To learn more about Maven dependencies, see the Maven introduction to dependencies and dependency reference.

Gradle

Declare the packages you want to download in the project build.gradle file. The following example declares version 1.0 of the package artifact as an external compile dependency.

To learn more about Gradle dependencies, see the Gradle documentation.

dependencies {
    compile group: 'group', name: 'artifact', version: '1.0'
}

What's next

• Learn about managing Node.js packages
• Learn about managing Python packages
• Learn about managing container images