Gradle Repositories

Gradle is a build automation tool that models your project with a declarative domain-specific language implemented in Groovy. Integrating Gradle with JFrog Artifactory provides a secure, private registry for your Gradle artifacts and gives you fine-grained control over your development and distribution pipeline. You can resolve plugins and libraries, and publish build outputs, through Artifactory instead of the public internet. For more information, see the Gradle documentation.

Gradle repositories in Artifactory provide the following benefits:

• Managing artifacts in Artifactory repositories using the Gradle client, the JFrog CLI jf gradle command, or the Artifactory Gradle Plugin.
• Calculating metadata for artifacts stored in Artifactory local repositories.
• Storing your internal and private Gradle artifacts securely in local repositories.
• Proxying and caching for remote Maven registries like https://repo1.maven.org/maven2/.
• Resolving and publishing with Maven or Ivy layouts from the same Gradle client.

Get Started with Gradle

To get started with Gradle, complete the following tasks:

1. Create a Gradle Repository
2. Connect Gradle to Artifactory

After completing these tasks, Gradle builds automatically resolve dependencies from Artifactory. If you run a publish job, artifacts are uploaded to your Gradle repository in Artifactory.

Create a Gradle Repository

This topic describes how to create a Gradle repository. You need a Gradle repository before you deploy and resolve Gradle packages. The primary repository types are:

• Local repositories: Store and share your internal and private Gradle packages with your organization.
• Remote repositories: Download packages from any remote location, including external package registries or other Artifactory endpoints.
• Virtual repositories: Aggregate remote and local repositories, enabling your organization to scale by providing a single URL that provides access to multiple repositories and types.

Artifactory also supports Federated Gradle repositories. For more information, see Federated Repositories.

For more information on JFrog repositories, see Repository Management.

Prerequisite: You need Admin or Project Admin permissions in Artifactory to create a repository. If you don't have Admin permissions, the option isn't available.

To create a Gradle repository:

1. In the Administration module, click Repositories > Create a Repository.

   

2. Select the type of repository you want to create.

3. Select the Gradle package type.

4. Configure the required fields for the repository:

   • For local repositories, in the Repository Key field, enter a meaningful name for the repository. For example, gradle-local. Gradle local repositories share their type-specific settings panel with Maven repositories, Ivy repositories, and sbt repositories. Gradle repositories use the maven-2-default repository layout. For more information on local repositories and their settings, see Local Repositories.
   • For remote repositories, verify the Repository URL and update as needed. For more information on remote repositories and their settings, see Remote Repositories.
   • For virtual repositories, select one or more local or remote repository types to include in the virtual repository. For more information on virtual repositories and their settings, see Virtual Repositories.

5. Click Create Repository. The repository is created and the Repositories page is displayed.

Connect Gradle to Artifactory

This topic provides details on configuring Gradle to work with Artifactory. To get up and running quickly, see Get Started with Gradle.

You can connect your Gradle client to any Artifactory repository type that uses Maven or Ivy layouts, including Gradle, Maven, Ivy, and sbt repositories. Use Artifactory Set Me Up to generate a build.gradle snippet and a gradle.properties file scoped to your chosen repository.

Prerequisite: Before connecting Gradle to Artifactory, you must have an existing repository with a compatible layout in Artifactory. For more information, see Create a Gradle Repository.

To connect Gradle to Artifactory:

1. Follow the instructions in Use Artifactory Set Me Up to Configure Package Manager Clients to open the Set Me Up for your Gradle repository and specify credentials for the configuration snippets.
2. On the Configure tab, for each of Plugin Resolver, Libs Resolver, and Libs Publisher, configure the following fields:
   • Select Use Maven, Use Ivy, or both. For more information, see Configuring Maven and Ivy Patterns for Gradle.
   • For Repository Key, select the repository to use for the resolver or publisher.
   • For Repository Layout, select the layout for the repository you selected in Repository Key if it isn't the default Maven layout.
3. For Gradle Version, select the Gradle version to use when generating the settings.
4. Click Generate Settings.
5. Click Download gradle.properties and Download Snippet.
6. Add the generated files to your project.

After completing configuration, Gradle builds publish build artifacts and resolve plugins and library dependencies from the specified Artifactory repositories.

Additional Gradle Information

• Use Gradle with JFrog CLI
• Configuring Maven and Ivy Patterns for Gradle

Use Gradle with JFrog CLI

JFrog CLI can generate Gradle build configurations and run Gradle builds with Artifactory integration.

To use Gradle with JFrog CLI:

1. Generate Gradle build configuration:

   Shell

   jf gradle-config --server-id-resolve=<SERVER_ID> --repo-resolve=<REPO_NAME> --server-id-deploy=<SERVER_ID> --repo-deploy=<REPO_NAME>

   Where:

   • <SERVER_ID>: The server ID you configured using jf config add
   • <REPO_NAME>: The name of the repository in Artifactory

   For example:

   Shell

   jf gradle-config --server-id-resolve=my-server --repo-resolve=gradle-virtual --server-id-deploy=my-server --repo-deploy=gradle-local

2. Run a Gradle build:

   Shell

   jf gradle build --build-name=<BUILD_NAME> --build-number=<BUILD_NUMBER>

   Where:

   • <BUILD_NAME>: A name for the build
   • <BUILD_NUMBER>: A number or identifier for the build run

   For example:

   Shell

   jf gradle build --build-name=my-java-app --build-number=1

For more information, see Use Gradle with JFrog CLI.

Configuring Maven and Ivy Patterns for Gradle

In the Gradle Set Me Up, you select a repository to use for the Plugin Resolver, Libs Resolver, and Libs Publisher. You must configure each entry to use Maven patterns, Ivy patterns, or both against the selected repository.

The following table explains the relationship between the Use Maven and Use Ivy settings, the selected repository, and repository layout.

Related Topics

• Maven Repositories
• sbt Repositories
• Repository Layouts