|
| 1 | +# Java Client for Grafeas |
| 2 | + |
| 3 | +Java idiomatic client for [Grafeas][grafeas]. |
| 4 | + |
| 5 | +[![Maven][maven-version-image]][maven-version-link] |
| 6 | +![Stability][stability-image] |
| 7 | + |
| 8 | +- [Client Library Documentation][javadocs] |
| 9 | + |
| 10 | +> Note: This client is a work-in-progress, and may occasionally |
| 11 | +> make backwards-incompatible changes. |
| 12 | +
|
| 13 | +## Quickstart |
| 14 | + |
| 15 | +[//]: # ({x-version-update-start:grafeas:released}) |
| 16 | +If you are using Maven, add this to your pom.xml file |
| 17 | +```xml |
| 18 | +<dependency> |
| 19 | + <groupId>io.grafeas</groupId> |
| 20 | + <artifactId>grafeas</artifactId> |
| 21 | + <version>0.23.0</version> |
| 22 | +</dependency> |
| 23 | +``` |
| 24 | +If you are using Gradle, add this to your dependencies |
| 25 | +```Groovy |
| 26 | +compile 'io.grafeas:grafeas:0.23.0' |
| 27 | +``` |
| 28 | +If you are using SBT, add this to your dependencies |
| 29 | +```Scala |
| 30 | +libraryDependencies += "io.grafeas" % "grafeas" % "0.23.0" |
| 31 | +``` |
| 32 | +[//]: # ({x-version-update-end}) |
| 33 | + |
| 34 | +## About Grafeas |
| 35 | + |
| 36 | +[Grafeas][grafeas] is an open artifact metadata API to audit and govern your |
| 37 | +software supply chain. |
| 38 | + |
| 39 | +Grafeas defines an API spec for managing metadata about software resources, such |
| 40 | +as container images, Virtual Machine (VM) images, JAR files, and scripts. You |
| 41 | +can use Grafeas to define and aggregate information about your project's |
| 42 | +components. Grafeas provides organizations with a central source of truth for |
| 43 | +tracking and enforcing policies across an ever growing set of software |
| 44 | +development teams and pipelines. Build, auditing, and compliance tools can use |
| 45 | +the Grafeas API to store, query, and retrieve comprehensive metadata on software |
| 46 | +components of all kinds. |
| 47 | + |
| 48 | +### Supported Implementations |
| 49 | + |
| 50 | +This library should be able to communicate with any Grafeas-backed API, |
| 51 | +however, you may be interested in other, custom implementations that extend this |
| 52 | +interface: |
| 53 | + |
| 54 | +* [Google Cloud Container Analysis](https://github.com/googleapis/java-containeranalysis) |
| 55 | + |
| 56 | +## Getting Started |
| 57 | + |
| 58 | +### Installation and setup |
| 59 | + |
| 60 | +You'll need to obtain the `grafeas` library. See the [Quickstart](#quickstart) section |
| 61 | +to add `grafeas` as a dependency in your code. |
| 62 | + |
| 63 | +## Troubleshooting |
| 64 | + |
| 65 | +To get help, follow the instructions in the [shared Troubleshooting document][troubleshooting]. |
| 66 | + |
| 67 | +## Transport |
| 68 | + |
| 69 | +Grafeas uses gRPC for the transport layer. |
| 70 | + |
| 71 | +## Java Versions |
| 72 | + |
| 73 | +Java 7 or above is required for using this client. |
| 74 | + |
| 75 | +## Versioning |
| 76 | + |
| 77 | +This library follows [Semantic Versioning](http://semver.org/). |
| 78 | + |
| 79 | +It is currently in major version zero (``0.y.z``), which means that anything may change at any time |
| 80 | +and the public API should not be considered stable. |
| 81 | + |
| 82 | +## Contributing |
| 83 | + |
| 84 | +Contributions to this library are always welcome and highly encouraged. |
| 85 | + |
| 86 | +See [CONTRIBUTING.md][contributing] documentation for more information on how to get started. |
| 87 | + |
| 88 | +Please note that this project is released with a Contributor Code of Conduct. By participating in |
| 89 | +this project you agree to abide by its terms. See [Code of Conduct][code-of-conduct] for more |
| 90 | +information. |
| 91 | + |
| 92 | +## License |
| 93 | + |
| 94 | +Apache 2.0 - See [LICENSE][license] for more information. |
| 95 | + |
| 96 | +## CI Status |
| 97 | + |
| 98 | +Java Version | Status |
| 99 | +------------ | ------ |
| 100 | +Java 7 | [![Kokoro CI][kokoro-badge-image-1]][kokoro-badge-link-1] |
| 101 | +Java 8 | [![Kokoro CI][kokoro-badge-image-2]][kokoro-badge-link-2] |
| 102 | +Java 8 OSX | [![Kokoro CI][kokoro-badge-image-3]][kokoro-badge-link-3] |
| 103 | +Java 8 Windows | [![Kokoro CI][kokoro-badge-image-4]][kokoro-badge-link-4] |
| 104 | +Java 11 | [![Kokoro CI][kokoro-badge-image-5]][kokoro-badge-link-5] |
| 105 | + |
| 106 | +[grafeas]: https://grafeas.io |
| 107 | +[javadocs]: https://googleapis.dev/java/grafeas/latest/ |
| 108 | +[kokoro-badge-image-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-grafeas/java7.svg |
| 109 | +[kokoro-badge-link-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-grafeas/java7.html |
| 110 | +[kokoro-badge-image-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-grafeas/java8.svg |
| 111 | +[kokoro-badge-link-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-grafeas/java8.html |
| 112 | +[kokoro-badge-image-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-grafeas/java8-osx.svg |
| 113 | +[kokoro-badge-link-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-grafeas/java8-osx.html |
| 114 | +[kokoro-badge-image-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-grafeas/java8-win.svg |
| 115 | +[kokoro-badge-link-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-grafeas/java8-win.html |
| 116 | +[kokoro-badge-image-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-grafeas/java11.svg |
| 117 | +[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-grafeas/java11.html |
| 118 | +[stability-image]: https://img.shields.io/badge/stability-alpha-orange |
| 119 | +[maven-version-image]: https://img.shields.io/maven-central/v/io.grafeas/grafeas.svg |
| 120 | +[maven-version-link]: https://search.maven.org/search?q=g:io.grafeas%20AND%20a:grafeas&core=gav |
| 121 | +[troubleshooting]: https://github.com/googleapis/google-cloud-common/blob/master/troubleshooting/readme.md#troubleshooting |
| 122 | +[contributing]: https://github.com/googleapis/java-grafeas/blob/master/CONTRIBUTING.md |
| 123 | +[code-of-conduct]: https://github.com/googleapis/java-grafeas/blob/master/CODE_OF_CONDUCT.md#contributor-code-of-conduct |
| 124 | +[license]: https://github.com/googleapis/java-grafeas/blob/master/LICENSE |
0 commit comments