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

Commit

Permalink
chore: generate README from templates
Browse files Browse the repository at this point in the history
  • Loading branch information
chingor13 committed Feb 25, 2020
1 parent fa5dabc commit 1da0cea
Show file tree
Hide file tree
Showing 3 changed files with 116 additions and 73 deletions.
181 changes: 114 additions & 67 deletions README.md
@@ -1,46 +1,51 @@
Google Cloud Java Client for Container Analysis
======================================
# Google Cloud Container Analysis Client for Java

Java idiomatic client for [Google Cloud Container Analysis][cloud-containeranalysis].
Java idiomatic client for [Cloud Container Analysis][product-docs].

[![Kokoro CI](http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/master.svg)](http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/master.html)
[![Maven](https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-containeranalysis.svg)](https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-containeranalysis.svg)
[![Codacy Badge](https://api.codacy.com/project/badge/grade/9da006ad7c3a4fe1abd142e77c003917)](https://www.codacy.com/app/mziccard/google-cloud-java)
[![Maven][maven-version-image]][maven-version-link]
![Stability][stability-image]

- [Product Documentation][containeranalysis-product-docs]
- [Client Library Documentation][containeranalysis-client-lib-docs]
- [Product Documentation][product-docs]
- [Client Library Documentation][javadocs]

Quickstart
----------
> Note: This client is a work-in-progress, and may occasionally
> make backwards-incompatible changes.
[//]: # ({x-version-update-start:google-cloud-containeranalysis:released})
If you are using Maven with Bom, Add this to your pom.xml file.
## Quickstart

If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file
```xml
<dependencyManagement>
<dependencies>
<dependencies>
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>libraries-bom</artifactId>
<version>4.1.1</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<dependencies>
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>libraries-bom</artifactId>
<version>0.119.1-beta</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>

<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-containeranalysis</artifactId>
</dependency>
<artifactId>google-cloud-containeranalysis</artifactId>
</dependency>
</dependencies>
```
If you are using Maven without Bom, Add this to your dependencies.

[//]: # ({x-version-update-start:google-cloud-containeranalysis:released})

If you are using Maven without BOM, add this to your dependencies:

```xml
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-containeranalysis</artifactId>
<version>0.119.1-beta</version>
</dependency>
```

If you are using Gradle, add this to your dependencies
```Groovy
compile 'com.google.cloud:google-cloud-containeranalysis:0.119.1-beta'
Expand All @@ -51,66 +56,108 @@ libraryDependencies += "com.google.cloud" % "google-cloud-containeranalysis" % "
```
[//]: # ({x-version-update-end})

Authentication
--------------
## Authentication

See the [Authentication](https://github.com/googleapis/google-cloud-java#authentication) section in the base directory's README.
See the [Authentication][authentication] section in the base directory's README.

About Google Cloud Container Analysis
----------------------------
## Getting Started

Google [Cloud Container Analysis API][cloud-containeranalysis] is an implementation of the Grafeas API, which stores, and enables querying and retrieval of critical metadata about all of your software artifacts.
### Prerequisites

See the [Container Analysis client library docs][containeranalysis-client-lib-docs] to learn how to use this Cloud Container Analysis API Client Library.
You will need a [Google Cloud Platform Console][developer-console] project with the Cloud Container Analysis [API enabled][enable-api].
You will need to [enable billing][enable-billing] to use Google Cloud Container Analysis.
[Follow these instructions][create-project] to get your project set up. You will also need to set up the local development environment by
[installing the Google Cloud SDK][cloud-sdk] and running the following commands in command line:
`gcloud auth login` and `gcloud config set project [YOUR PROJECT ID]`.

Getting Started
---------------
#### Prerequisites
You will need a [Google Developers Console](https://console.developers.google.com/) project with the Container Analysis API enabled. [Follow these instructions](https://cloud.google.com/resource-manager/docs/creating-managing-projects) to get your project set up. You will also need to set up the local development environment by [installing the Google Cloud SDK](https://cloud.google.com/sdk/) and running the following commands in command line: `gcloud auth login` and `gcloud config set project [YOUR PROJECT ID]`.
### Installation and setup

#### Installation and setup
You'll need to obtain the `google-cloud-containeranalysis` library. See the [Quickstart](#quickstart) section to add `google-cloud-containeranalysis` as a dependency in your code.
You'll need to obtain the `google-cloud-containeranalysis` library. See the [Quickstart](#quickstart) section
to add `google-cloud-containeranalysis` as a dependency in your code.

Troubleshooting
---------------
## About Cloud Container Analysis

To get help, follow the instructions in the [shared Troubleshooting document](https://github.com/googleapis/google-cloud-common/blob/master/troubleshooting/readme.md#troubleshooting).

Transport
---------
Container Analysis uses gRPC for the transport layer.
[Cloud Container Analysis][product-docs] is a service that provides vulnerability scanning and metadata storage for software artifacts. The service performs vulnerability scans on built software artifacts, such as the images in Container Registry, then stores the resulting metadata and makes it available for consumption through an API. The metadata may come from several sources, including vulnerability scanning, other Cloud services, and third-party providers.

Java Versions
-------------
See the [Cloud Container Analysis client library docs][javadocs] to learn how to
use this Cloud Container Analysis Client Library.

Java 7 or above is required for using this client.

Versioning
----------

This library follows [Semantic Versioning](http://semver.org/).

It is currently in major version one (``1.y.z``), which means that the public API should be considered stable.

Contributing
------------

Contributions to this library are always welcome and highly encouraged.
## Troubleshooting

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

## Transport

Cloud Container Analysis uses gRPC for the transport layer.

## Java Versions

See `google-cloud`'s [CONTRIBUTING] documentation and the [shared documentation](https://github.com/googleapis/google-cloud-common/blob/master/contributing/readme.md#how-to-contribute-to-gcloud) for more information on how to get started.
Java 7 or above is required for using this client.

## Versioning

This library follows [Semantic Versioning](http://semver.org/).

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][code-of-conduct] for more information.

License
-------
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.

Apache 2.0 - See [LICENSE] for more information.

## Contributing


Contributions to this library are always welcome and highly encouraged.

[CONTRIBUTING]:https://github.com/googleapis/google-cloud-java/blob/master/CONTRIBUTING.md
[code-of-conduct]:https://github.com/googleapis/google-cloud-java/blob/master/CODE_OF_CONDUCT.md#contributor-code-of-conduct
[LICENSE]: https://github.com/googleapis/google-cloud-java/blob/master/LICENSE
[cloud-platform]: https://cloud.google.com/
[cloud-containeranalysis]: https://cloud.google.com/container-registry/docs/container-analysis
[containeranalysis-product-docs]: https://cloud.google.com/container-registry/docs/container-analysis
[containeranalysis-client-lib-docs]: https://googleapis.dev/java/google-cloud-clients/latest/index.html?com/google/cloud/devtools/containeranalysis/v1beta1/package-summary.html
See [CONTRIBUTING][contributing] for more information 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][code-of-conduct] for more
information.

## License

Apache 2.0 - See [LICENSE][license] for more information.

## CI Status

Java Version | Status
------------ | ------
Java 7 | [![Kokoro CI][kokoro-badge-image-1]][kokoro-badge-link-1]
Java 8 | [![Kokoro CI][kokoro-badge-image-2]][kokoro-badge-link-2]
Java 8 OSX | [![Kokoro CI][kokoro-badge-image-3]][kokoro-badge-link-3]
Java 8 Windows | [![Kokoro CI][kokoro-badge-image-4]][kokoro-badge-link-4]
Java 11 | [![Kokoro CI][kokoro-badge-image-5]][kokoro-badge-link-5]

[product-docs]: https://cloud.google.com/container-registry/docs/container-analysis
[javadocs]: https://googleapis.dev/java/google-cloud-containeranalysis/latest/
[kokoro-badge-image-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-containeranalysis/java7.svg
[kokoro-badge-link-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-containeranalysis/java7.html
[kokoro-badge-image-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-containeranalysis/java8.svg
[kokoro-badge-link-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-containeranalysis/java8.html
[kokoro-badge-image-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-containeranalysis/java8-osx.svg
[kokoro-badge-link-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-containeranalysis/java8-osx.html
[kokoro-badge-image-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-containeranalysis/java8-win.svg
[kokoro-badge-link-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-containeranalysis/java8-win.html
[kokoro-badge-image-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-containeranalysis/java11.svg
[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-containeranalysis/java11.html
[stability-image]: https://img.shields.io/badge/stability-beta-yellow
[maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-containeranalysis.svg
[maven-version-link]: https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-containeranalysis&core=gav
[authentication]: https://github.com/googleapis/google-cloud-java#authentication
[developer-console]: https://console.developers.google.com/
[create-project]: https://cloud.google.com/resource-manager/docs/creating-managing-projects
[cloud-sdk]: https://cloud.google.com/sdk/
[troubleshooting]: https://github.com/googleapis/google-cloud-common/blob/master/troubleshooting/readme.md#troubleshooting
[contributing]: https://github.com/googleapis/java-containeranalysis/blob/master/CONTRIBUTING.md
[code-of-conduct]: https://github.com/googleapis/java-containeranalysis/blob/master/CODE_OF_CONDUCT.md#contributor-code-of-conduct
[license]: https://github.com/googleapis/java-containeranalysis/blob/master/LICENSE
[enable-billing]: https://cloud.google.com/apis/docs/getting-started#enabling_billing
[enable-api]: https://console.cloud.google.com/flows/enableapi?apiid=containeranalysis.googleapis.com
[libraries-bom]: https://github.com/GoogleCloudPlatform/cloud-opensource-java/wiki/The-Google-Cloud-Platform-Libraries-BOM
[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
2 changes: 1 addition & 1 deletion synth.metadata
@@ -1,5 +1,5 @@
{
"updateTime": "2020-02-24T22:46:06.403853Z",
"updateTime": "2020-02-25T20:36:46.752852Z",
"sources": [
{
"generator": {
Expand Down
6 changes: 1 addition & 5 deletions synth.py
Expand Up @@ -72,9 +72,5 @@
java.format_code(f'grpc-google-cloud-{service}-{version}/src')
java.format_code(f'proto-google-cloud-{service}-{version}/src')

common_templates = gcp.CommonTemplates()
templates = common_templates.java_library()
s.copy(templates, excludes=[
'README.md',
])
java.common_templates()

0 comments on commit 1da0cea

Please sign in to comment.