You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by pk...@apache.org on 2026/05/05 15:37:15 UTC
(commons-release-plugin) branch fix/add-dots created (now 1111a71)
This is an automated email from the ASF dual-hosted git repository.
ppkarwasz pushed a change to branch fix/add-dots
in repository https://gitbox.apache.org/repos/asf/commons-release-plugin.git
at 1111a71 Add dots to each sentence
This branch includes the following new commits:
new 1033457 fix: add `@since` tags to SLSA models
new 1111a71 Add dots to each sentence
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
(commons-release-plugin) 02/02: Add dots to each sentence
Posted by pk...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
ppkarwasz pushed a commit to branch fix/add-dots
in repository https://gitbox.apache.org/repos/asf/commons-release-plugin.git
commit 1111a711ca8f417fa82baab85a303078e8b33523
Author: Piotr P. Karwasz <pk...@apache.org>
AuthorDate: Tue May 5 17:36:23 2026 +0200
Add dots to each sentence
This change adds a dot to each Javadoc sentence.
---
.../release/plugin/slsa/v1_2/BuildDefinition.java | 28 ++++++-------
.../release/plugin/slsa/v1_2/BuildMetadata.java | 24 +++++------
.../commons/release/plugin/slsa/v1_2/Builder.java | 18 ++++-----
.../release/plugin/slsa/v1_2/DsseEnvelope.java | 18 ++++-----
.../release/plugin/slsa/v1_2/Provenance.java | 16 ++++----
.../plugin/slsa/v1_2/ResourceDescriptor.java | 46 +++++++++++-----------
.../release/plugin/slsa/v1_2/RunDetails.java | 22 +++++------
.../release/plugin/slsa/v1_2/Signature.java | 10 ++---
.../release/plugin/slsa/v1_2/Statement.java | 16 ++++----
9 files changed, 99 insertions(+), 99 deletions(-)
diff --git a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/BuildDefinition.java b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/BuildDefinition.java
index 25cf6cf..f3198ac 100644
--- a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/BuildDefinition.java
+++ b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/BuildDefinition.java
@@ -67,8 +67,8 @@ public class BuildDefinition {
/**
* Creates a new BuildDefinition with the given build type and external parameters.
*
- * @param buildType URI indicating what type of build was performed
- * @param externalParameters inputs passed to the build
+ * @param buildType URI indicating what type of build was performed.
+ * @param externalParameters inputs passed to the build.
*/
public BuildDefinition(String buildType, Map<String, Object> externalParameters) {
this.buildType = buildType;
@@ -93,7 +93,7 @@ public class BuildDefinition {
*
* <p>Determines the meaning of {@code externalParameters} and {@code internalParameters}.</p>
*
- * @return the build type URI
+ * @return the build type URI.
*/
public String getBuildType() {
return buildType;
@@ -102,7 +102,7 @@ public class BuildDefinition {
/**
* Gets the inputs passed to the build, such as command-line arguments or environment variables.
*
- * @return the external parameters map, or {@code null} if not set
+ * @return the external parameters map, or {@code null} if not set.
*/
public Map<String, Object> getExternalParameters() {
return externalParameters;
@@ -112,7 +112,7 @@ public class BuildDefinition {
* Gets the artifacts the build depends on, such as sources, dependencies, build tools, and base images,
* specified by URI and digest.
*
- * @return the internal parameters map, or {@code null} if not set
+ * @return the internal parameters map, or {@code null} if not set.
*/
public Map<String, Object> getInternalParameters() {
return internalParameters;
@@ -123,7 +123,7 @@ public class BuildDefinition {
*
* <p>Considered incomplete unless resolved materials are present.</p>
*
- * @return the list of resolved dependencies, or {@code null} if not set
+ * @return the list of resolved dependencies, or {@code null} if not set.
*/
public List<ResourceDescriptor> getResolvedDependencies() {
return resolvedDependencies;
@@ -137,8 +137,8 @@ public class BuildDefinition {
/**
* Sets the URI indicating what type of build was performed.
*
- * @param buildType the build type URI
- * @return this for chaining
+ * @param buildType the build type URI.
+ * @return this for chaining.
*/
public BuildDefinition setBuildType(String buildType) {
this.buildType = buildType;
@@ -148,8 +148,8 @@ public class BuildDefinition {
/**
* Sets the inputs passed to the build.
*
- * @param externalParameters the external parameters map
- * @return this for chaining
+ * @param externalParameters the external parameters map.
+ * @return this for chaining.
*/
public BuildDefinition setExternalParameters(Map<String, Object> externalParameters) {
this.externalParameters = externalParameters;
@@ -159,8 +159,8 @@ public class BuildDefinition {
/**
* Sets the artifacts the build depends on.
*
- * @param internalParameters the internal parameters map
- * @return this for chaining
+ * @param internalParameters the internal parameters map.
+ * @return this for chaining.
*/
public BuildDefinition setInternalParameters(Map<String, Object> internalParameters) {
this.internalParameters = internalParameters;
@@ -170,8 +170,8 @@ public class BuildDefinition {
/**
* Sets the materials that influenced the build.
*
- * @param resolvedDependencies the list of resolved dependencies
- * @return this for chaining
+ * @param resolvedDependencies the list of resolved dependencies.
+ * @return this for chaining.
*/
public BuildDefinition setResolvedDependencies(List<ResourceDescriptor> resolvedDependencies) {
this.resolvedDependencies = resolvedDependencies;
diff --git a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/BuildMetadata.java b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/BuildMetadata.java
index b3407f2..022cd98 100644
--- a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/BuildMetadata.java
+++ b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/BuildMetadata.java
@@ -51,9 +51,9 @@ public class BuildMetadata {
/**
* Creates a new BuildMetadata instance with all fields set.
*
- * @param invocationId identifier for this build invocation
- * @param startedOn timestamp when the build started
- * @param finishedOn timestamp when the build completed
+ * @param invocationId identifier for this build invocation.
+ * @param startedOn timestamp when the build started.
+ * @param finishedOn timestamp when the build completed.
*/
public BuildMetadata(String invocationId, OffsetDateTime startedOn, OffsetDateTime finishedOn) {
this.invocationId = invocationId;
@@ -73,7 +73,7 @@ public class BuildMetadata {
/**
* Gets the timestamp of when the build completed, serialized as RFC 3339 in UTC ({@code "Z"} suffix).
*
- * @return the completion timestamp, or {@code null} if not set
+ * @return the completion timestamp, or {@code null} if not set.
*/
public OffsetDateTime getFinishedOn() {
return finishedOn;
@@ -82,7 +82,7 @@ public class BuildMetadata {
/**
* Gets the identifier for this build invocation.
*
- * @return the invocation identifier, or {@code null} if not set
+ * @return the invocation identifier, or {@code null} if not set.
*/
public String getInvocationId() {
return invocationId;
@@ -91,7 +91,7 @@ public class BuildMetadata {
/**
* Gets the timestamp of when the build started, serialized as RFC 3339 in UTC ({@code "Z"} suffix).
*
- * @return the start timestamp, or {@code null} if not set
+ * @return the start timestamp, or {@code null} if not set.
*/
public OffsetDateTime getStartedOn() {
return startedOn;
@@ -105,8 +105,8 @@ public class BuildMetadata {
/**
* Sets the timestamp of when the build completed.
*
- * @param finishedOn the completion timestamp
- * @return this for chaining
+ * @param finishedOn the completion timestamp.
+ * @return this for chaining.
*/
public BuildMetadata setFinishedOn(OffsetDateTime finishedOn) {
this.finishedOn = finishedOn;
@@ -116,8 +116,8 @@ public class BuildMetadata {
/**
* Sets the identifier for this build invocation.
*
- * @param invocationId the invocation identifier
- * @return this for chaining
+ * @param invocationId the invocation identifier.
+ * @return this for chaining.
*/
public BuildMetadata setInvocationId(String invocationId) {
this.invocationId = invocationId;
@@ -127,8 +127,8 @@ public class BuildMetadata {
/**
* Sets the timestamp of when the build started.
*
- * @param startedOn the start timestamp
- * @return this for chaining
+ * @param startedOn the start timestamp.
+ * @return this for chaining.
*/
public BuildMetadata setStartedOn(OffsetDateTime startedOn) {
this.startedOn = startedOn;
diff --git a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Builder.java b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Builder.java
index 460fcc3..7d5d89d 100644
--- a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Builder.java
+++ b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Builder.java
@@ -61,7 +61,7 @@ public class Builder {
* Gets orchestrator dependencies that do not run within the build workload and do not affect the build output,
* but may affect provenance generation or security guarantees.
*
- * @return the list of builder dependencies, or {@code null} if not set
+ * @return the list of builder dependencies, or {@code null} if not set.
*/
public List<ResourceDescriptor> getBuilderDependencies() {
return builderDependencies;
@@ -70,7 +70,7 @@ public class Builder {
/**
* Gets the identifier of the builder.
*
- * @return the builder identifier URI
+ * @return the builder identifier URI.
*/
public String getId() {
return id;
@@ -79,7 +79,7 @@ public class Builder {
/**
* Gets a map of build platform component names to their versions.
*
- * @return the version map, or {@code null} if not set
+ * @return the version map, or {@code null} if not set.
*/
public Map<String, String> getVersion() {
return version;
@@ -93,8 +93,8 @@ public class Builder {
/**
* Sets the orchestrator dependencies that may affect provenance generation or security guarantees.
*
- * @param builderDependencies the list of builder dependencies
- * @return this for chaining
+ * @param builderDependencies the list of builder dependencies.
+ * @return this for chaining.
*/
public Builder setBuilderDependencies(List<ResourceDescriptor> builderDependencies) {
this.builderDependencies = builderDependencies;
@@ -104,8 +104,8 @@ public class Builder {
/**
* Sets the identifier of the builder.
*
- * @param id the builder identifier URI
- * @return this for chaining
+ * @param id the builder identifier URI.
+ * @return this for chaining.
*/
public Builder setId(String id) {
this.id = id;
@@ -115,8 +115,8 @@ public class Builder {
/**
* Sets the map of build platform component names to their versions.
*
- * @param version the version map
- * @return this for chaining
+ * @param version the version map.
+ * @return this for chaining.
*/
public Builder setVersion(Map<String, String> version) {
this.version = version;
diff --git a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/DsseEnvelope.java b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/DsseEnvelope.java
index 14ffc43..bb67a84 100644
--- a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/DsseEnvelope.java
+++ b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/DsseEnvelope.java
@@ -61,7 +61,7 @@ public class DsseEnvelope {
*
* <p>When serialized to JSON the bytes are Base64-encoded.</p>
*
- * @return the payload bytes, or {@code null} if not set
+ * @return the payload bytes, or {@code null} if not set.
*/
public byte[] getPayload() {
return payload;
@@ -70,7 +70,7 @@ public class DsseEnvelope {
/**
* Gets the payload type URI.
*
- * @return the payload type, never {@code null} in a valid envelope
+ * @return the payload type, never {@code null} in a valid envelope.
*/
public String getPayloadType() {
return payloadType;
@@ -79,7 +79,7 @@ public class DsseEnvelope {
/**
* Gets the list of signatures over the PAE-encoded payload.
*
- * @return the signatures, or {@code null} if not set
+ * @return the signatures, or {@code null} if not set.
*/
public List<Signature> getSignatures() {
return signatures;
@@ -93,8 +93,8 @@ public class DsseEnvelope {
/**
* Sets the serialized payload bytes.
*
- * @param payload the payload bytes
- * @return this for chaining
+ * @param payload the payload bytes.
+ * @return this for chaining.
*/
public DsseEnvelope setPayload(byte[] payload) {
this.payload = payload;
@@ -104,8 +104,8 @@ public class DsseEnvelope {
/**
* Sets the payload type URI.
*
- * @param payloadType the payload type URI
- * @return this for chaining
+ * @param payloadType the payload type URI.
+ * @return this for chaining.
*/
public DsseEnvelope setPayloadType(String payloadType) {
this.payloadType = payloadType;
@@ -115,8 +115,8 @@ public class DsseEnvelope {
/**
* Sets the list of signatures over the PAE-encoded payload.
*
- * @param signatures the signatures
- * @return this for chaining
+ * @param signatures the signatures.
+ * @return this for chaining.
*/
public DsseEnvelope setSignatures(List<Signature> signatures) {
this.signatures = signatures;
diff --git a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Provenance.java b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Provenance.java
index 5fa6b88..bba9689 100644
--- a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Provenance.java
+++ b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Provenance.java
@@ -51,8 +51,8 @@ public class Provenance {
/**
* Creates a new Provenance with the given build definition and run details.
*
- * @param buildDefinition inputs that defined the build
- * @param runDetails details about the build invocation
+ * @param buildDefinition inputs that defined the build.
+ * @param runDetails details about the build invocation.
*/
public Provenance(BuildDefinition buildDefinition, RunDetails runDetails) {
this.buildDefinition = buildDefinition;
@@ -76,7 +76,7 @@ public class Provenance {
*
* <p>Includes source code, dependencies, build tools, base images, and other materials.</p>
*
- * @return the build definition, or {@code null} if not set
+ * @return the build definition, or {@code null} if not set.
*/
public BuildDefinition getBuildDefinition() {
return buildDefinition;
@@ -85,7 +85,7 @@ public class Provenance {
/**
* Gets the details about the invocation of the build tool and the environment in which it was run.
*
- * @return the run details, or {@code null} if not set
+ * @return the run details, or {@code null} if not set.
*/
public RunDetails getRunDetails() {
return runDetails;
@@ -99,8 +99,8 @@ public class Provenance {
/**
* Sets the build definition describing all inputs that produced the build output.
*
- * @param buildDefinition the build definition
- * @return this for chaining
+ * @param buildDefinition the build definition.
+ * @return this for chaining.
*/
public Provenance setBuildDefinition(BuildDefinition buildDefinition) {
this.buildDefinition = buildDefinition;
@@ -110,8 +110,8 @@ public class Provenance {
/**
* Sets the details about the invocation of the build tool and the environment in which it was run.
*
- * @param runDetails the run details
- * @return this for chaining
+ * @param runDetails the run details.
+ * @return this for chaining.
*/
public Provenance setRunDetails(RunDetails runDetails) {
this.runDetails = runDetails;
diff --git a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/ResourceDescriptor.java b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/ResourceDescriptor.java
index c681b91..c6027a3 100644
--- a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/ResourceDescriptor.java
+++ b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/ResourceDescriptor.java
@@ -62,8 +62,8 @@ public class ResourceDescriptor {
/**
* Creates a new ResourceDescriptor with the given URI and digest.
*
- * @param uri URI identifying the resource
- * @param digest map of digest algorithm names to their hex-encoded values
+ * @param uri URI identifying the resource.
+ * @param digest map of digest algorithm names to their hex-encoded values.
*/
public ResourceDescriptor(String uri, Map<String, String> digest) {
this.uri = uri;
@@ -85,7 +85,7 @@ public class ResourceDescriptor {
/**
* Gets additional key-value metadata about the resource, such as filename, size, or builder-specific attributes.
*
- * @return the annotations map, or {@code null} if not set
+ * @return the annotations map, or {@code null} if not set.
*/
public Map<String, Object> getAnnotations() {
return annotations;
@@ -94,7 +94,7 @@ public class ResourceDescriptor {
/**
* Gets the raw contents of the resource, base64-encoded when serialized to JSON.
*
- * @return the resource content, or {@code null} if not set
+ * @return the resource content, or {@code null} if not set.
*/
public byte[] getContent() {
return content;
@@ -105,7 +105,7 @@ public class ResourceDescriptor {
*
* <p>Common keys include {@code "sha256"} and {@code "sha512"}.</p>
*
- * @return the digest map, or {@code null} if not set
+ * @return the digest map, or {@code null} if not set.
*/
public Map<String, String> getDigest() {
return digest;
@@ -114,7 +114,7 @@ public class ResourceDescriptor {
/**
* Gets the download URI for the resource, if different from {@link #getUri()}.
*
- * @return the download location URI, or {@code null} if not set
+ * @return the download location URI, or {@code null} if not set.
*/
public String getDownloadLocation() {
return downloadLocation;
@@ -123,7 +123,7 @@ public class ResourceDescriptor {
/**
* Gets the media type of the resource (e.g., {@code "application/octet-stream"}).
*
- * @return the media type, or {@code null} if not set
+ * @return the media type, or {@code null} if not set.
*/
public String getMediaType() {
return mediaType;
@@ -132,7 +132,7 @@ public class ResourceDescriptor {
/**
* Gets the name of the resource.
*
- * @return the resource name, or {@code null} if not set
+ * @return the resource name, or {@code null} if not set.
*/
public String getName() {
return name;
@@ -141,7 +141,7 @@ public class ResourceDescriptor {
/**
* Gets the URI identifying the resource.
*
- * @return the resource URI, or {@code null} if not set
+ * @return the resource URI, or {@code null} if not set.
*/
public String getUri() {
return uri;
@@ -155,8 +155,8 @@ public class ResourceDescriptor {
/**
* Sets additional key-value metadata about the resource.
*
- * @param annotations the annotations map
- * @return this for chaining
+ * @param annotations the annotations map.
+ * @return this for chaining.
*/
public ResourceDescriptor setAnnotations(Map<String, Object> annotations) {
this.annotations = annotations;
@@ -166,8 +166,8 @@ public class ResourceDescriptor {
/**
* Sets the raw contents of the resource.
*
- * @param content the resource content
- * @return this for chaining
+ * @param content the resource content.
+ * @return this for chaining.
*/
public ResourceDescriptor setContent(byte[] content) {
this.content = content;
@@ -177,8 +177,8 @@ public class ResourceDescriptor {
/**
* Sets the map of cryptographic digest algorithms to their hex-encoded values.
*
- * @param digest the digest map
- * @return this for chaining
+ * @param digest the digest map.
+ * @return this for chaining.
*/
public ResourceDescriptor setDigest(Map<String, String> digest) {
this.digest = digest;
@@ -188,8 +188,8 @@ public class ResourceDescriptor {
/**
* Sets the download URI for the resource.
*
- * @param downloadLocation the download location URI
- * @return this for chaining
+ * @param downloadLocation the download location URI.
+ * @return this for chaining.
*/
public ResourceDescriptor setDownloadLocation(String downloadLocation) {
this.downloadLocation = downloadLocation;
@@ -199,8 +199,8 @@ public class ResourceDescriptor {
/**
* Sets the media type of the resource.
*
- * @param mediaType the media type
- * @return this for chaining
+ * @param mediaType the media type.
+ * @return this for chaining.
*/
public ResourceDescriptor setMediaType(String mediaType) {
this.mediaType = mediaType;
@@ -210,8 +210,8 @@ public class ResourceDescriptor {
/**
* Sets the name of the resource.
*
- * @param name the resource name
- * @return this for chaining
+ * @param name the resource name.
+ * @return this for chaining.
*/
public ResourceDescriptor setName(String name) {
this.name = name;
@@ -221,8 +221,8 @@ public class ResourceDescriptor {
/**
* Sets the URI identifying the resource.
*
- * @param uri the resource URI
- * @return this for chaining
+ * @param uri the resource URI.
+ * @return this for chaining.
*/
public ResourceDescriptor setUri(String uri) {
this.uri = uri;
diff --git a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/RunDetails.java b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/RunDetails.java
index c8e373f..b9f5050 100644
--- a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/RunDetails.java
+++ b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/RunDetails.java
@@ -56,8 +56,8 @@ public class RunDetails {
/**
* Creates a new RunDetails with the given builder and metadata.
*
- * @param builder entity that executed the build
- * @param metadata metadata about the build invocation
+ * @param builder entity that executed the build.
+ * @param metadata metadata about the build invocation.
*/
public RunDetails(Builder builder, BuildMetadata metadata) {
this.builder = builder;
@@ -81,7 +81,7 @@ public class RunDetails {
*
* <p>Trusted to have correctly performed the operation and populated this provenance.</p>
*
- * @return the builder, or {@code null} if not set
+ * @return the builder, or {@code null} if not set.
*/
public Builder getBuilder() {
return builder;
@@ -90,7 +90,7 @@ public class RunDetails {
/**
* Gets artifacts produced as a side effect of the build that are not the primary output.
*
- * @return the list of byproduct artifacts, or {@code null} if not set
+ * @return the list of byproduct artifacts, or {@code null} if not set.
*/
public List<ResourceDescriptor> getByproducts() {
return byproducts;
@@ -99,7 +99,7 @@ public class RunDetails {
/**
* Gets the metadata about the build invocation, including its identifier and timing.
*
- * @return the build metadata, or {@code null} if not set
+ * @return the build metadata, or {@code null} if not set.
*/
public BuildMetadata getMetadata() {
return metadata;
@@ -113,8 +113,8 @@ public class RunDetails {
/**
* Sets the builder that executed the invocation.
*
- * @param builder the builder
- * @return this for chaining
+ * @param builder the builder.
+ * @return this for chaining.
*/
public RunDetails setBuilder(Builder builder) {
this.builder = builder;
@@ -124,8 +124,8 @@ public class RunDetails {
/**
* Sets the artifacts produced as a side effect of the build that are not the primary output.
*
- * @param byproducts the list of byproduct artifacts
- * @return this for chaining
+ * @param byproducts the list of byproduct artifacts.
+ * @return this for chaining.
*/
public RunDetails setByproducts(List<ResourceDescriptor> byproducts) {
this.byproducts = byproducts;
@@ -135,8 +135,8 @@ public class RunDetails {
/**
* Sets the metadata about the build invocation.
*
- * @param metadata the build metadata
- * @return this for chaining
+ * @param metadata the build metadata.
+ * @return this for chaining.
*/
public RunDetails setMetadata(BuildMetadata metadata) {
this.metadata = metadata;
diff --git a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Signature.java b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Signature.java
index 99554fd..48b0205 100644
--- a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Signature.java
+++ b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Signature.java
@@ -68,7 +68,7 @@ public class Signature {
/**
* Gets the raw signature bytes.
*
- * @return the signature bytes, or {@code null} if not set
+ * @return the signature bytes, or {@code null} if not set.
*/
public byte[] getSig() {
return sig;
@@ -82,8 +82,8 @@ public class Signature {
/**
* Sets the key identifier hint.
*
- * @param keyid the key identifier, or {@code null} to leave unset
- * @return this for chaining
+ * @param keyid the key identifier, or {@code null} to leave unset.
+ * @return this for chaining.
*/
public Signature setKeyid(String keyid) {
this.keyid = keyid;
@@ -93,8 +93,8 @@ public class Signature {
/**
* Sets the raw signature bytes.
*
- * @param sig the signature bytes
- * @return this for chaining
+ * @param sig the signature bytes.
+ * @return this for chaining.
*/
public Signature setSig(byte[] sig) {
this.sig = sig;
diff --git a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Statement.java b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Statement.java
index 581fe03..3a12ad4 100644
--- a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Statement.java
+++ b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Statement.java
@@ -58,7 +58,7 @@ public class Statement {
/**
* Type of JSON object.
*
- * @return Always {@value TYPE}
+ * @return Always {@value TYPE}.
*/
@JsonProperty("_type")
public String getType() {
@@ -71,7 +71,7 @@ public class Statement {
* <p>Unset is treated the same as set-but-empty. May be omitted if {@code predicateType} fully describes the
* predicate.</p>
*
- * @return the provenance predicate, or {@code null} if not set
+ * @return the provenance predicate, or {@code null} if not set.
*/
public Provenance getPredicate() {
return predicate;
@@ -80,7 +80,7 @@ public class Statement {
/**
* Gets the URI identifying the type of the predicate.
*
- * @return the predicate type URI, or {@code null} if no predicate has been set
+ * @return the predicate type URI, or {@code null} if no predicate has been set.
*/
public String getPredicateType() {
return predicateType;
@@ -91,7 +91,7 @@ public class Statement {
*
* <p>Each element represents a single artifact. Artifacts are matched purely by digest, regardless of content type.</p>
*
- * @return the list of subject artifacts, or {@code null} if not set
+ * @return the list of subject artifacts, or {@code null} if not set.
*/
public List<ResourceDescriptor> getSubject() {
return subject;
@@ -105,8 +105,8 @@ public class Statement {
/**
* Sets the provenance predicate and automatically assigns {@code predicateType} to the SLSA provenance v1 URI.
*
- * @param predicate the provenance predicate
- * @return this for chaining
+ * @param predicate the provenance predicate.
+ * @return this for chaining.
*/
public Statement setPredicate(Provenance predicate) {
this.predicate = predicate;
@@ -117,8 +117,8 @@ public class Statement {
/**
* Sets the set of software artifacts that the attestation applies to.
*
- * @param subject the list of subject artifacts
- * @return this for chaining
+ * @param subject the list of subject artifacts.
+ * @return this for chaining.
*/
public Statement setSubject(List<ResourceDescriptor> subject) {
this.subject = subject;
(commons-release-plugin) 01/02: fix: add `@since` tags to SLSA models
Posted by pk...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
ppkarwasz pushed a commit to branch fix/add-dots
in repository https://gitbox.apache.org/repos/asf/commons-release-plugin.git
commit 10334571be32a4c1c2bd0ba95caba932c612f8cb
Author: Piotr P. Karwasz <pk...@apache.org>
AuthorDate: Tue May 5 17:03:25 2026 +0200
fix: add `@since` tags to SLSA models
---
pom.xml | 2 +-
.../org/apache/commons/release/plugin/slsa/v1_2/BuildDefinition.java | 1 +
.../java/org/apache/commons/release/plugin/slsa/v1_2/BuildMetadata.java | 1 +
src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Builder.java | 1 +
.../java/org/apache/commons/release/plugin/slsa/v1_2/DsseEnvelope.java | 1 +
.../java/org/apache/commons/release/plugin/slsa/v1_2/Provenance.java | 1 +
.../org/apache/commons/release/plugin/slsa/v1_2/ResourceDescriptor.java | 1 +
.../java/org/apache/commons/release/plugin/slsa/v1_2/RunDetails.java | 1 +
.../java/org/apache/commons/release/plugin/slsa/v1_2/Signature.java | 1 +
.../java/org/apache/commons/release/plugin/slsa/v1_2/Statement.java | 1 +
10 files changed, 10 insertions(+), 1 deletion(-)
diff --git a/pom.xml b/pom.xml
index 23b1da9..3f6bb75 100644
--- a/pom.xml
+++ b/pom.xml
@@ -26,7 +26,7 @@
</parent>
<artifactId>commons-release-plugin</artifactId>
<packaging>maven-plugin</packaging>
- <version>1.9.3-SNAPSHOT</version>
+ <version>1.10.0-SNAPSHOT</version>
<name>Apache Commons Release Plugin</name>
<description>
Apache Maven Mojo for Apache Commons Release tasks.
diff --git a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/BuildDefinition.java b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/BuildDefinition.java
index 43bcb94..25cf6cf 100644
--- a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/BuildDefinition.java
+++ b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/BuildDefinition.java
@@ -30,6 +30,7 @@ import com.fasterxml.jackson.annotation.JsonProperty;
* {@link Provenance} record.</p>
*
* @see <a href="https://slsa.dev/spec/v1.2">SLSA v1.2 Specification</a>
+ * @since 1.10.0
*/
public class BuildDefinition {
diff --git a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/BuildMetadata.java b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/BuildMetadata.java
index 595e0f7..b3407f2 100644
--- a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/BuildMetadata.java
+++ b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/BuildMetadata.java
@@ -27,6 +27,7 @@ import com.fasterxml.jackson.annotation.JsonProperty;
* Metadata about a build invocation: its identifier and start and finish timestamps.
*
* @see <a href="https://slsa.dev/spec/v1.2">SLSA v1.2 Specification</a>
+ * @since 1.10.0
*/
@JsonInclude(JsonInclude.Include.NON_NULL)
public class BuildMetadata {
diff --git a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Builder.java b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Builder.java
index 508d622..460fcc3 100644
--- a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Builder.java
+++ b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Builder.java
@@ -28,6 +28,7 @@ import com.fasterxml.jackson.annotation.JsonProperty;
* Entity that executed the build and is trusted to have correctly performed the operation and populated the provenance.
*
* @see <a href="https://slsa.dev/spec/v1.2">SLSA v1.2 Specification</a>
+ * @since 1.10.0
*/
public class Builder {
diff --git a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/DsseEnvelope.java b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/DsseEnvelope.java
index e68e575..14ffc43 100644
--- a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/DsseEnvelope.java
+++ b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/DsseEnvelope.java
@@ -26,6 +26,7 @@ import com.fasterxml.jackson.annotation.JsonProperty;
* DSSE (Dead Simple Signing Envelope) that wraps a signed in-toto statement payload.
*
* @see <a href="https://github.com/secure-systems-lab/dsse/blob/v1.0.2/envelope.md">DSSE Envelope specification</a>
+ * @since 1.10.0
*/
public class DsseEnvelope {
diff --git a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Provenance.java b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Provenance.java
index 6002dce..5fa6b88 100644
--- a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Provenance.java
+++ b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Provenance.java
@@ -28,6 +28,7 @@ import com.fasterxml.jackson.annotation.JsonProperty;
* used as the {@code predicate} field of an in-toto {@link Statement}.</p>
*
* @see <a href="https://slsa.dev/spec/v1.2">SLSA v1.2 Specification</a>
+ * @since 1.10.0
*/
@JsonInclude(JsonInclude.Include.NON_NULL)
public class Provenance {
diff --git a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/ResourceDescriptor.java b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/ResourceDescriptor.java
index cb3510e..c681b91 100644
--- a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/ResourceDescriptor.java
+++ b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/ResourceDescriptor.java
@@ -28,6 +28,7 @@ import com.fasterxml.jackson.annotation.JsonProperty;
* <p>Used to represent inputs to, outputs from, or byproducts of the build process.</p>
*
* @see <a href="https://slsa.dev/spec/v1.2">SLSA v1.2 Specification</a>
+ * @since 1.10.0
*/
@JsonInclude(JsonInclude.Include.NON_NULL)
public class ResourceDescriptor {
diff --git a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/RunDetails.java b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/RunDetails.java
index da14aef..c8e373f 100644
--- a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/RunDetails.java
+++ b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/RunDetails.java
@@ -26,6 +26,7 @@ import com.fasterxml.jackson.annotation.JsonProperty;
* Details about the build invocation: the builder identity, execution metadata, and any byproduct artifacts.
*
* @see <a href="https://slsa.dev/spec/v1.2">SLSA v1.2 Specification</a>
+ * @since 1.10.0
*/
@JsonInclude(JsonInclude.Include.NON_NULL)
public class RunDetails {
diff --git a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Signature.java b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Signature.java
index 77e7698..99554fd 100644
--- a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Signature.java
+++ b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Signature.java
@@ -26,6 +26,7 @@ import com.fasterxml.jackson.annotation.JsonProperty;
* A single cryptographic signature within a DSSE envelope.
*
* @see <a href="https://github.com/secure-systems-lab/dsse/blob/v1.0.2/envelope.md">DSSE Envelope specification</a>
+ * @since 1.10.0
*/
@JsonInclude(JsonInclude.Include.NON_NULL)
public class Signature {
diff --git a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Statement.java b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Statement.java
index 1d779c6..581fe03 100644
--- a/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Statement.java
+++ b/src/main/java/org/apache/commons/release/plugin/slsa/v1_2/Statement.java
@@ -25,6 +25,7 @@ import com.fasterxml.jackson.annotation.JsonProperty;
* In-toto v1 attestation envelope that binds a set of subject artifacts to an SLSA provenance predicate.
*
* @see <a href="https://github.com/in-toto/attestation/blob/main/spec/v1/statement.md">in-toto Statement v1</a>
+ * @since 1.10.0
*/
public class Statement {