Skip to content
This repository has been archived by the owner on Sep 16, 2023. It is now read-only.

Latest commit

 

History

History
124 lines (91 loc) · 5.05 KB

README.md

File metadata and controls

124 lines (91 loc) · 5.05 KB

Java Client for Grafeas

Java idiomatic client for Grafeas.

Maven Stability

Note: This client is a work-in-progress, and may occasionally make backwards-incompatible changes.

Quickstart

If you are using Maven, add this to your pom.xml file

<dependency>
  <groupId>io.grafeas</groupId>
  <artifactId>grafeas</artifactId>
  <version>0.24.1</version>
</dependency>

If you are using Gradle, add this to your dependencies

compile 'io.grafeas:grafeas:0.24.1'

If you are using SBT, add this to your dependencies

libraryDependencies += "io.grafeas" % "grafeas" % "0.24.1"

About Grafeas

Grafeas is an open artifact metadata API to audit and govern your software supply chain.

Grafeas defines an API spec for managing metadata about software resources, such as container images, Virtual Machine (VM) images, JAR files, and scripts. You can use Grafeas to define and aggregate information about your project's components. Grafeas provides organizations with a central source of truth for tracking and enforcing policies across an ever growing set of software development teams and pipelines. Build, auditing, and compliance tools can use the Grafeas API to store, query, and retrieve comprehensive metadata on software components of all kinds.

Supported Implementations

This library should be able to communicate with any Grafeas-backed API, however, you may be interested in other, custom implementations that extend this interface:

Getting Started

Installation and setup

You'll need to obtain the grafeas library. See the Quickstart section to add grafeas as a dependency in your code.

Troubleshooting

To get help, follow the instructions in the shared Troubleshooting document.

Transport

Grafeas uses gRPC for the transport layer.

Java Versions

Java 7 or above is required for using this client.

Versioning

This library follows Semantic Versioning.

It is currently in major version zero (0.y.z), which means that anything may change at any time and the public API should not be considered stable.

Contributing

Contributions to this library are always welcome and highly encouraged.

See CONTRIBUTING.md documentation for more information on how to get started.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See Code of Conduct for more information.

License

Apache 2.0 - See LICENSE for more information.

CI Status

Java Version Status
Java 7 Kokoro CI
Java 8 Kokoro CI
Java 8 OSX Kokoro CI
Java 8 Windows Kokoro CI
Java 11 Kokoro CI