Managing Maven with JFrog CLI

The JFrog CLI extends the capabilities of the native Maven build tool, enabling seamless integration with Artifactory for dependency resolution and artifact deployment.

When you use jf mvn commands (for example, jf mvn clean install), the CLI acts as an intermediary layer that provides Artifactory-aware capabilities such as:

To support different development and CI/CD workflows, the JFrog CLI supports two modes of operation:

In Wrapped Mode, the JFrog CLI actively participates in the Maven workflow. It reads configuration from .jfrog/projects/maven.yaml and injects repository settings into the Maven build process.

Requirements:

Limitation:

The jf mvn-config command supports specifying one repository per resolution type:

For multi-repository dependency resolution, use Native Mode instead.

In Native Mode, the JFrog CLI executes Maven without injecting configuration. All repository settings must be defined in your pom.xml or settings.xml files.

Key Benefit: Multi-Repository Support

Native Mode enables Maven to resolve dependencies from multiple repositories as defined in your pom.xml, exactly like the standard mvn command. This is ideal for enterprise environments where projects depend on artifacts from multiple internal and external repositories.

Enabling Native Mode:

export JFROG_RUN_NATIVE=true
    

Use Wrapped Mode when you want:

Use Native Mode when you need:

The jf mvn command triggers the Maven client while resolving dependencies and deploying artifacts from and to Artifactory.

Syntax:

jf mvn <goals and options> [command options]
    

Command Options

Configures Maven repositories for Wrapped Mode.

Syntax:

jf mvn-config [command options]
    

Options

Step 1: Configure Repositories

jf mvn-config \
  --server-id-resolve=my-server \
  --server-id-deploy=my-server \
  --repo-resolve-releases=libs-release \
  --repo-resolve-snapshots=libs-snapshot \
  --repo-deploy-releases=libs-release-local \
  --repo-deploy-snapshots=libs-snapshot-local
    

Step 2: Run Maven Build

jf mvn clean install \
  --build-name=my-maven-build \
  --build-number=1
    

Step 3: Publish Build-Info

jf rt bp my-maven-build 1
    

Prerequisites:

1. Configure JFrog CLI authentication:

jf c add my-server \
  --url=https://mycompany.jfrog.io \
  --access-token=my-token
    

2. Configure Maven authentication using Artifactory Set Me Up

Step 1: Enable Native Mode

export JFROG_RUN_NATIVE=true
    

Step 2: Define Multiple Repositories in pom.xml

<project>
  <repositories>
    <repository>
      <id>artifactory-releases</id>
      <url>https://mycompany.jfrog.io/artifactory/libs-release</url>
    </repository>

    <repository>
      <id>artifactory-snapshots</id>
      <url>https://mycompany.jfrog.io/artifactory/libs-snapshot</url>
    </repository>

    <repository>
      <id>corporate-libs</id>
      <url>https://mycompany.jfrog.io/artifactory/corporate-maven</url>
    </repository>

    <repository>
      <id>third-party</id>
      <url>https://mycompany.jfrog.io/artifactory/third-party-maven</url>
    </repository>
  </repositories>

  <distributionManagement>
    <repository>
      <id>artifactory-releases</id>
      <url>https://mycompany.jfrog.io/artifactory/libs-release-local</url>
    </repository>
    <snapshotRepository>
      <id>artifactory-snapshots</id>
      <url>https://mycompany.jfrog.io/artifactory/libs-snapshot-local</url>
    </snapshotRepository>
  </distributionManagement>
</project>
    

Step 3: Configure Authentication in settings.xml

<settings>
  <servers>
    <server>
      <id>artifactory-releases</id>
      <username>${env.ARTIFACTORY_USER}</username>
      <password>${env.ARTIFACTORY_PASSWORD}</password>
    </server>
    <server>
      <id>artifactory-snapshots</id>
      <username>${env.ARTIFACTORY_USER}</username>
      <password>${env.ARTIFACTORY_PASSWORD}</password>
    </server>
    <server>
      <id>corporate-libs</id>
      <username>${env.ARTIFACTORY_USER}</username>
      <password>${env.ARTIFACTORY_PASSWORD}</password>
    </server>
    <server>
      <id>third-party</id>
      <username>${env.ARTIFACTORY_USER}</username>
      <password>${env.ARTIFACTORY_PASSWORD}</password>
    </server>
  </servers>
</settings>
    

Step 4: Run Maven Build with Build-Info

jf mvn clean install \
  --build-name=my-enterprise-build \
  --build-number=${BUILD_NUMBER}
    

Step 5: Publish Build-Info

jf rt bp my-enterprise-build ${BUILD_NUMBER}
    

GitHub Actions Example (Native Mode)

name: Maven Build with JFrog CLI (Native Mode)

on: [push, pull_request]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-java@v4
        with:
          java-version: '17'
          distribution: 'temurin'

      - uses: jfrog/setup-jfrog-cli@v4
        env:
          JF_URL: ${{ secrets.JF_URL }}
          JF_ACCESS_TOKEN: ${{ secrets.JF_ACCESS_TOKEN }}

      - name: Configure Maven settings.xml
        run: |
          mkdir -p ~/.m2
          echo '${{ secrets.MAVEN_SETTINGS_XML }}' > ~/.m2/settings.xml

      - name: Build (Native Mode)
        env:
          JFROG_RUN_NATIVE: 'true'
        run: |
          jf mvn clean install \
            --build-name=my-app \
            --build-number=${{ github.run_number }}

      - name: Publish Build Info
        run: jf rt bp my-app ${{ github.run_number }}
    

Q: Why do I still use jf mvn in Native Mode?

A: Native Mode runs Maven unmodified, but the jf prefix is still required for build-info collection and secure credential handling.

Q: Does Native Mode support build-info collection?

A: Yes. Build-info is supported when --build-name and --build-number are provided.

Q: Can I use multiple repositories for dependency resolution?

A: Yes, using Native Mode. Wrapped Mode supports only one repository per type.

Q: How do I publish build-info without Maven plugins?

A: Use Native Mode:

export JFROG_RUN_NATIVE=true
jf mvn clean install --build-name=my-build --build-number=1
jf rt bp my-build 1
    

Q: Is jf mvn-config required in Native Mode?

A: No. It is ignored.

Q: Why does my build fail with "no config file was found"?

A: You are running Wrapped Mode without jf mvn-config. Either configure it or enable Native Mode.

Environment Variables