Skip to content

Latest commit

 

History

History
 
 

rules_sonatype

README.md

JetBrains team project

bazel sonatype

A set of rules for publishing your project to the Maven Central repository through the REST API of Sonatype Nexus. Allows releasing Java projects to the Maven central repository.

Prerequisites

  • Create a Sonatype Repository account
    • Follow the instruction in the Central Repository documentation site.
      • Create a Sonatype account
      • Create a GPG key
      • Open a JIRA ticket to get a permission for synchronizing your project to the Central Repository (aka Maven Central).
    • GPG key must be available as the default key on the machine

Configurations

In the Workspace file, the following must be added in order install:

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

# ======================================================================================================================
# ----------------------------------------------------------------------------------------------------------------------
# ======================================================================================================================
# rules_jvm_external

RULES_JVM_EXTERNAL_TAG = "4.2"

RULES_JVM_EXTERNAL_SHA = "cd1a77b7b02e8e008439ca76fd34f5b07aecb8c752961f9640dea15e9e5ba1ca"

http_archive(
    name = "rules_jvm_external",
    sha256 = RULES_JVM_EXTERNAL_SHA,
    strip_prefix = "rules_jvm_external-{}".format(RULES_JVM_EXTERNAL_TAG),
    url = "https://github.com/bazelbuild/rules_jvm_external/archive/{}.zip".format(RULES_JVM_EXTERNAL_TAG),
)

# ----------------------------------------------------------------------------------------------------------------------
load("@bazel_sonatype//:defs.bzl", "sonatype_dependencies")

sonatype_dependencies()

# ======================================================================================================================
# bazel_skylib

BAZEL_SKYLIB_TAG = "1.2.1"

BAZEL_SKYLIB_SHA = "f7be3474d42aae265405a592bb7da8e171919d74c16f082a5457840f06054728"

http_archive(
    name = "bazel_skylib",
    sha256 = BAZEL_SKYLIB_SHA,
    url = "https://github.com/bazelbuild/bazel-skylib/releases/download/{}/bazel-skylib-{}.tar.gz".format(BAZEL_SKYLIB_TAG, BAZEL_SKYLIB_TAG),
)

# ======================================================================================================================
# io_bazel_rules_scala

IO_BAZEL_RULES_SCALA_TAG = "9b85affa2e08a350a4315882b602eda55b262356"

IO_BAZEL_RULES_SCALA_SHA = "b9eaf9bd026b5b1702d6705b4e953a5b73c49705552a6f2da83edd995b2dbe1f"

http_archive(
    name = "io_bazel_rules_scala",
    sha256 = IO_BAZEL_RULES_SCALA_SHA,
    strip_prefix = "rules_scala-{}".format(IO_BAZEL_RULES_SCALA_TAG),
    url = "https://github.com/bazelbuild/rules_scala/archive/{}.zip".format(IO_BAZEL_RULES_SCALA_TAG),
)

# ----------------------------------------------------------------------------------------------------------------------
load("@io_bazel_rules_scala//:scala_config.bzl", "scala_config")

scala_config(scala_version = "2.13.8")

# ----------------------------------------------------------------------------------------------------------------------
load("@io_bazel_rules_scala//scala:scala.bzl", "scala_repositories")

scala_repositories()

# ----------------------------------------------------------------------------------------------------------------------
load("@rules_proto//proto:repositories.bzl", "rules_proto_dependencies", "rules_proto_toolchains")

rules_proto_dependencies()

rules_proto_toolchains()

# ----------------------------------------------------------------------------------------------------------------------
load("@io_bazel_rules_scala//scala:toolchains.bzl", "scala_register_toolchains")

scala_register_toolchains()

# ----------------------------------------------------------------------------------------------------------------------
load("@io_bazel_rules_scala//testing:scalatest.bzl", "scalatest_repositories", "scalatest_toolchain")

scalatest_repositories()

scalatest_toolchain()

# ======================================================================================================================

BAZEL_SONATYPE_TAG = "1.0.0"

http_archive(
    name = "bazel_sonatype",
    strip_prefix = "bazel-sonatype-{}".format(BAZEL_SONATYPE_TAG),
    url = "https://github.com/JetBrains/bazel-sonatype/archive/{}.zip".format(BAZEL_SONATYPE_TAG),
)

load("@bazel_sonatype//:defs.bzl", "sonatype_dependencies")

sonatype_dependencies()

A sonatype_java_export must be defined in order to publish. This is similar to a java_library but with some new parameters:

# /src/BUILD
load("@bazel_sonatype//:defs.bzl", "sonatype_java_export")

sonatype_java_export(
    name = "project_name",
    maven_coordinates = "com.example:project:0.0.1",
    maven_profile = "com.example",
    pom_template = "//:pom.xml", # Omittable but sonatype will reject reject publishing without more information than the template has
    srcs = glob(["*.java"]),
    deps = [
        "//src",
    ],
)

The pom file must be defined for publishing to Sonatype's Release, with the following format, remember to update the template with your data!:

<?xml version="1.0" encoding="UTF-8"?>
<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"
         xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <modelVersion>4.0.0</modelVersion>

    <groupId>{groupId}</groupId>
    <artifactId>{artifactId}</artifactId>
    <version>{version}</version>

    <name>Your project name</name>
    <description>Some description</description>
    <url>https://www.yourcompany.com/</url>

    <dependencies>
        {dependencies}
    </dependencies>
    <developers>
        <developer> 
            <id>developerid</id>
            <name>Your Name</name>
            <email>your@email.com</email>
            <url>https://github.com/developerid</url>
        </developer>
    <licenses>
        <license>
            <name>Your licence</name>
            <url>http://yourlicence.txt</url>
        </license>
    </licenses>
    <scm>
        <connection>scm:git:github.com/yourcompany/project.git</connection>
        <developerConnection>scm:git:git@github.com:yourcompany/project.git</developerConnection>
        <url>https://github.com/yourcompany/project</url>
    </scm>
</project>

You must leave all variables in brackets like that, since that will be filled internally. Make sure to add the following fields:

  • Project Name
  • Project Description
  • Developer Information
  • License Information
  • SCM URL

Publishing can now be done using bazel run:

bazel run --stamp \
  --define "maven_repo=https://oss.sonatype.org/service/local" \ # Defaults to the legacy Sonatype repository
  --define "maven_user=user" \
  --define "maven_password=password" \
  //src:project_name.publish

It is also possible to publish a snapshot of a build. This can be done by guaranteeing that the version in the sonatype_java_export's coordinates ends with -SNAPSHOT

# /src/BUILD
load("@bazel_sonatype//:defs.bzl", "sonatype_java_export")

sonatype_java_export(
    name = "project_name",
    maven_coordinates = "com.example:project:0.0.1-SNAPSHOT",
    maven_profile = "com.example",
    pom_template = "//:pom.xml", # Omittable
    srcs = glob(["*.java"]),
    deps = [
        "//src",
    ],
)

And then running bazel run:

bazel run --stamp \
  --define "maven_repo=https://oss.sonatype.org/service/local" \ # Defaults to the legacy Sonatype repository
  --define "maven_user=user" \
  --define "maven_password=password" \
  --define "gpg_sign=true" \ # Defaults to true
  //src:project_name.publish

Publishing locally all the artifacts is also possible, if a file based url is provided for bazel run:

bazel run --stamp \
  --define "maven_repo=file://$HOME/.m2/repository" \ # Defaults to the legacy Sonatype repository
  --define "gpg_sign=false" \ # Defaults to false
  //src:project_name.publish