/cloud-opensource-java

Tools for detecting and avoiding linkage errors in GCP open source projects

Primary LanguageJavaApache License 2.0Apache-2.0

unstable

This project explores common infrastructure and best practices for open source Java projects for the Google Cloud Platform (GCP).

Google Cloud Platform Java Dependency Dashboard

Google Cloud Platform Java Dependency Dashboard (runs daily; work in progress) shows multiple checks on the consistency among Google Cloud Java libraries. For manually generating the dashboard, see its README.

Google Best Practices for Java Libraries

Google Best Practices for Java Libraries are rules that minimize problems for consumers of interconnected Java libraries.

Linkage Checker

Linkage Checker Maven Enforcer Rule

Linkage Checker Enforcer Rule detects linkage errors in the current Maven project as part of build.

For its usage, see the enforcer rule documentation.

Linkage Checker Gradle Plugin

Linkage Checker Gradle Plugin provides the linkageCheck task that detects linkage errors in the current Gradle project.

For its usage, see the plugin documentation.

GCP Libraries BOM

The GCP Libraries BOM is a Bill-of-Materials (BOM) that provides consistent versions of Google Cloud Java libraries that work together without linkage errors.

Development

This project is built using Maven.

Requirements

  1. Maven 3.6.0 or later.

  2. JDK 8 or 11.

  3. git

  4. Clone the project to a local directory using git clone git@github.com:GoogleCloudPlatform/cloud-opensource-java.git.