Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Java client information. #346

Merged
merged 7 commits into from
Nov 19, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
addressing comments and reorg.
Signed-off-by: hayleycd <cook.hayley@gmail.com>
hayleycd committed Nov 19, 2024
commit 2df369f0671ff60496c625aca75213321c58c3d1
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
---
type: docs
category: Java
title: Java Client Overview
weight: 5
category: Language Clients
title: Java
weight: 20
---

[`sigstore-java`](https://github.com/sigstore/sigstore-java#sigstore-java) is a java client for interacting with the Sigstore infrastructure.

## Features

- Includes both [Maven](https://github.com/sigstore/sigstore-java/tree/main/sigstore-maven-plugin) and [Gradle](https://github.com/sigstore/sigstore-java/tree/main/sigstore-gradle) build plugins
- [Maven](https://github.com/sigstore/sigstore-java/tree/main/sigstore-maven-plugin) and [Gradle](https://github.com/sigstore/sigstore-java/tree/main/sigstore-gradle) signing plugins
- Keyless signing and verifying
- [API](https://javadoc.io/doc/dev.sigstore/sigstore-java)
- Java native signing and verifying [API](https://javadoc.io/doc/dev.sigstore/sigstore-java)

## Installation

@@ -51,9 +51,9 @@

More information on the Gradle build plugin is available in the [project repository](https://github.com/sigstore/sigstore-java/tree/main/sigstore-gradle#sigstore-gradle).

## Example
## API Usage Examples

### Signing example
### Signing

```java
Path testArtifact = Paths.get("path/to/my/file.jar")
@@ -66,7 +66,7 @@
String bundleJson = result.toJson();
```

### Verifying example
### Verifying

#### Get artifact and bundle

@@ -104,4 +104,4 @@

### Additional examples

[Additional](https://github.com/sigstore/sigstore-java/tree/main/examples/hello-world#sigstore-examples) [examples](https://github.com/sigstore/sigstore-java/tree/main/examples/pgp#pgp-test-keys-for-examples) are available in the project repository.
[Additional](https://github.com/sigstore/sigstore-java/tree/main/examples/hello-world#sigstore-examples) [examples](https://github.com/sigstore/sigstore-java/tree/main/examples/pgp#pgp-test-keys-for-examples) are available in the project repository.

Check failure on line 107 in content/en/language_clients/java.md

GitHub Actions / markdownlint

Files should end with a single newline character

content/en/language_clients/java.md:107:249 MD047/single-trailing-newline Files should end with a single newline character https://github.com/DavidAnson/markdownlint/blob/v0.29.0/doc/md047.md
11 changes: 0 additions & 11 deletions content/en/language_clients/java/_index.html

This file was deleted.

15 changes: 8 additions & 7 deletions content/en/language_clients/language_client_overview.md
Original file line number Diff line number Diff line change
@@ -9,11 +9,12 @@

Language client summaries are available in the main Sigstore documentation, but complete documentation is hosted in the individual project repositories.

- [Go](../go/overview)
- [Java](../java/overview)
- [JavaScript](../javascript/overview)
- [Python](../python/overview)
- [Rust](../rust/overview)
- [Ruby](https://github.com/sigstore/sigstore-ruby#sigstore)
| Language Client Summary | Project Repository |
| ---------------------------------------- | -------------------------------------------------------------- |
| [Go](../go) | [sigstore-go](https://github.com/sigstore/sigstore-go) |
| [Java](../java) | [sigstore-java](https://github.com/sigstore/sigstore-java) |
| [Javascript](../javascript) | [sigstore-js](https://github.com/sigstore/sigstore-js) |
| [Python](../python) | [sigstore-python](https://github.com/sigstore/sigstore-python) |
| Ruby (available soon) | [sigstore-ruby](https://github.com/sigstore/sigstore-ruby) |
| [Rust](../rust) | [sigstore-rs](https://github.com/sigstore/sigstore-rs) |

Language client documentation is hosted in the individual project repositories. Project summaries are currently being added to the main Sigstore documentation.
You are viewing a condensed version of this merge commit. You can view the full changes here.