Refresh Java language client docs for sigstore-java 2.0.0#429
Open
smythp wants to merge 2 commits intosigstore:mainfrom
Open
Refresh Java language client docs for sigstore-java 2.0.0#429smythp wants to merge 2 commits intosigstore:mainfrom
smythp wants to merge 2 commits intosigstore:mainfrom
Conversation
✅ Deploy Preview for docssigstore ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Generated via mill crank doc_refresh. Changes: - Bump Maven/Gradle plugin versions 1.0.0 -> 2.0.0 - Add Requirements section (Java 11+, Gradle 7.5+) - Add DSSE attestation section with Rekor V2 example - Add TUF integration and GitHub Actions OIDC to features - Add 'Signing individual files' subsection with sign-base plugin - Add stable-API note (only KeylessSigner / KeylessVerifier guaranteed) - Add Known Limitations section - Fix compile errors in API Usage examples (missing .build(), incorrect 'new' keyword on builder, missing semicolons) - Complete imports in all Java snippets - Switch Maven code fence from java to xml - Introduce OIDC/DSSE/TUF/Rekor with definitions and links on first mention; trim marketing fluff Signed-off-by: Patrick Smyth <patrick.smyth@chainguard.dev>
Independent review (codex agent against the live PR diff) caught real factual issues that the doc_refresh chain's accuracy stage missed. Cross-checked each finding against sigstore-java v2.0.0 source before applying. Blocker fixes: - Fix VerificationOptions import: dev.sigstore.verification.VerificationOptions -> dev.sigstore.VerificationOptions (the snippet would not compile as written; verified against sigstore-java/src/main/java/dev/sigstore/VerificationOptions.java) - Fix sign-base SigstoreSignFilesTask reference: use FQCN dev.sigstore.sign.tasks.SigstoreSignFilesTask::class so the Gradle snippet works without an import (verified against sigstore-gradle/sigstore-gradle-sign-base-plugin) - Soften stable API note to match upstream README: '... and the classes exposed by those APIs' (was overstated as only KeylessSigner / KeylessVerifier) Additions and clarifications: - Add GitHub Actions section with required OIDC permissions block (permissions: id-token: write, contents: read), matching the snippet in upstream Maven and Gradle READMEs - Add Gradle plugin version to the sign-base snippet - Expand the offline limitation to cover both signing and verification, noting that verification supports a custom trusted root for restricted environments Signed-off-by: Patrick Smyth <patrick.smyth@chainguard.dev>
smythp
force-pushed
the
java-refresh-2026-04-23
branch
from
28d7ac3 to
0859810
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Refreshes
content/en/language_clients/java.mdto reflect sigstore-java 2.0.0 (released Nov 2025). The existing page pinned the 1.0.0-era plugin versions and was missing several features the library now offers.Content updates
sign-baseGradle pluginKeylessSignerandKeylessVerifierare guaranteed stable per the upstream README)Fixes to existing examples
The API Usage snippets in the current page had a few bugs that would prevent them from compiling:
.build()call at the end of theVerificationOptionschainnewkeyword on theKeylessVerifier.builder()call (it's a static builder)Fixed and verified against the current library API.
Tone / style
javatoxmlTest plan
Notes for reviewers
Version numbers and install snippets were cross-checked against the sigstore-java 2.0.0 release and upstream README at the time of writing. Code example fixes are based on the current public API surface documented in the Javadoc — please flag if any of the examples here drift from preferred usage patterns in the project.