docs/content/actions/guides/publishing-java-packages-with-gradle.md

title, intro, product, redirect_from, versions, type, topics

title	intro	product	redirect_from	versions	type	topics
Publishing Java packages with Gradle	You can use Gradle to publish Java packages to a registry as part of your continuous integration (CI) workflow.	{% data reusables.gated-features.actions %}	/actions/language-and-framework-guides/publishing-java-packages-with-gradle	free-pro-team enterprise-server github-ae * >=2.22 *	tutorial	Packaging Publishing Java Gradle

{% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %}

Introduction

{% data reusables.github-actions.publishing-java-packages-intro %}

Prerequisites

We recommend that you have a basic understanding of workflow files and configuration options. For more information, see "Learn {% data variables.product.prodname_actions %}."

For more information about creating a CI workflow for your Java project with Gradle, see "Building and testing Java with Gradle."

You may also find it helpful to have a basic understanding of the following:

• "Configuring npm for use with {% data variables.product.prodname_registry %}"
• "Environment variables"
• "Encrypted secrets"
• "Authentication in a workflow"

About package configuration

The groupId and artifactId fields in the MavenPublication section of the build.gradle file create a unique identifier for your package that registries use to link your package to a registry. This is similar to the groupId and artifactId fields of the Maven pom.xml file. For more information, see the "Maven Publish Plugin" in the Gradle documentation.

The build.gradle file also contains configuration for the distribution management repositories that Gradle will publish packages to. Each repository must have a name, a deployment URL, and credentials for authentication.

Publishing packages to the Maven Central Repository

Each time you create a new release, you can trigger a workflow to publish your package. The workflow in the example below runs when the release event triggers with type created. The workflow publishes the package to the Maven Central Repository if CI tests pass. For more information on the release event, see "Events that trigger workflows."

You can define a new Maven repository in the publishing block of your build.gradle file that points to your package repository. For example, if you were deploying to the Maven Central Repository through the OSSRH hosting project, your build.gradle could specify a repository with the name "OSSRH".

{% raw %}

publishing {
  ...

  repositories {
    maven {
      name = "OSSRH"
      url = "https://oss.sonatype.org/service/local/staging/deploy/maven2/"
      credentials {
        username = System.getenv("MAVEN_USERNAME")
        password = System.getenv("MAVEN_PASSWORD")
      }
    }
  }
}

{% endraw %}

With this configuration, you can create a workflow that publishes your package to the Maven Central Repository by running the gradle publish command. You’ll also need to provide environment variables that contain the username and password to authenticate to the repository.

In the deploy step, you’ll need to set environment variables for the username and password or token that you use to authenticate to the Maven repository. For more information, see "Creating and using encrypted secrets."

{% raw %}

name: Publish package to the Maven Central Repository
on:
  release:
    types: [created]
jobs:
  publish:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Set up Java
        uses: actions/setup-java@v1
        with:
          java-version: 1.8
      - name: Publish package
        run: gradle publish
        env:
          MAVEN_USERNAME: ${{ secrets.OSSRH_USERNAME }}
          MAVEN_PASSWORD: ${{ secrets.OSSRH_TOKEN }}

{% endraw %}

{% data reusables.github-actions.gradle-workflow-steps %}

1. Runs the gradle publish command to publish to the OSSRH Maven repository. The MAVEN_USERNAME environment variable will be set with the contents of your OSSRH_USERNAME secret, and the MAVEN_PASSWORD environment variable will be set with the contents of your OSSRH_TOKEN secret.

   For more information about using secrets in your workflow, see "Creating and using encrypted secrets."

Publishing packages to {% data variables.product.prodname_registry %}

Each time you create a new release, you can trigger a workflow to publish your package. The workflow in the example below runs when the release event triggers with type created. The workflow publishes the package to {% data variables.product.prodname_registry %} if CI tests pass. For more information on the release event, see "Events that trigger workflows."

You can define a new Maven repository in the publishing block of your build.gradle that points to {% data variables.product.prodname_registry %}. In that repository configuration, you can also take advantage of environment variables set in your CI workflow run. You can use the GITHUB_ACTOR environment variable as a username, and you can set the GITHUB_TOKEN environment variable with your GITHUB_TOKEN secret.

The GITHUB_TOKEN exists in your repository by default and has read and write permissions for packages in the repository where the workflow runs. For more information, see "Authenticating with the GITHUB_TOKEN."

For example, if your organization is named "octocat" and your repository is named "hello-world", then the {% data variables.product.prodname_registry %} configuration in build.gradle would look similar to the below example.

{% raw %}

publishing {
  ...

  repositories {
    maven {
      name = "GitHubPackages"
      url = "https://maven.pkg.github.com/octocat/hello-world"
      credentials {
        username = System.getenv("GITHUB_ACTOR")
        password = System.getenv("GITHUB_TOKEN")
      }
    }
  }
}

{% endraw %}

With this configuration, you can create a workflow that publishes your package to the Maven Central Repository by running the gradle publish command.

{% raw %}

name: Publish package to GitHub Packages
on:
  release:
    types: [created]
jobs:
  publish:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: actions/setup-java@v1
        with:
          java-version: 1.8
      - name: Publish package
        run: gradle publish
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

{% endraw %}

{% data reusables.github-actions.gradle-workflow-steps %}

1. Runs the gradle publish command to publish to {% data variables.product.prodname_registry %}. The GITHUB_TOKEN environment variable will be set with the content of the GITHUB_TOKEN secret.

   For more information about using secrets in your workflow, see "Creating and using encrypted secrets."

Publishing packages to the Maven Central Repository and {% data variables.product.prodname_registry %}

You can publish your packages to both the Maven Central Repository and {% data variables.product.prodname_registry %} by configuring each in your build.gradle file.

Ensure your build.gradle file includes a repository for both your {% data variables.product.prodname_dotcom %} repository and your Maven Central Repository provider.

For example, if you deploy to the Central Repository through the OSSRH hosting project, you might want to specify it in a distribution management repository with the name set to OSSRH. If you deploy to {% data variables.product.prodname_registry %}, you might want to specify it in a distribution management repository with the name set to GitHubPackages.

If your organization is named "octocat" and your repository is named "hello-world", then the {% data variables.product.prodname_registry %} configuration in build.gradle would look similar to the below example.

{% raw %}

publishing {
  ...

  repositories {
    maven {
      name = "OSSRH"
      url = "https://oss.sonatype.org/service/local/staging/deploy/maven2/"
      credentials {
        username = System.getenv("MAVEN_USERNAME")
        password = System.getenv("MAVEN_PASSWORD")
      }
    }
    maven {
      name = "GitHubPackages"
      url = "https://maven.pkg.github.com/octocat/hello-world"
      credentials {
        username = System.getenv("GITHUB_ACTOR")
        password = System.getenv("GITHUB_TOKEN")
      }
    }
  }
}

{% endraw %}

With this configuration, you can create a workflow that publishes your package to both the Maven Central Repository and {% data variables.product.prodname_registry %} by running the gradle publish command.

{% raw %}

name: Publish package to the Maven Central Repository and GitHub Packages
on:
  release:
    types: [created]
jobs:
  publish:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Set up Java
        uses: actions/setup-java@v1
        with:
          java-version: 1.8
      - name: Publish to the Maven Central Repository
        run: gradle publish
        env:
          MAVEN_USERNAME: ${{ secrets.OSSRH_USERNAME }}
          MAVEN_PASSWORD: ${{ secrets.OSSRH_TOKEN }}
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

{% endraw %}

{% data reusables.github-actions.gradle-workflow-steps %}

1. Runs the gradle publish command to publish to the OSSRH Maven repository and {% data variables.product.prodname_registry %}. The MAVEN_USERNAME environment variable will be set with the contents of your OSSRH_USERNAME secret, and the MAVEN_PASSWORD environment variable will be set with the contents of your OSSRH_TOKEN secret. The GITHUB_TOKEN environment variable will be set with the content of the GITHUB_TOKEN secret.

   For more information about using secrets in your workflow, see "Creating and using encrypted secrets."