Update generated docs/pipeline-api.md

and fix a few linter issues. Signed-off-by: Andrea Frittoli <andrea.frittoli@uk.ibm.com>
tektoncd · Jan 20, 2023 · adc1d04 · adc1d04
1 parent dde7837
commit adc1d04
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 11 deletions.
diff --git a/docs/pipeline-api.md b/docs/pipeline-api.md
@@ -4569,6 +4569,9 @@ reasons that emerge from underlying resources are not included here</p>
 </tr><tr><td><p>&#34;TaskRunImagePullFailed&#34;</p></td>
 <td><p>TaskRunReasonImagePullFailed is the reason set when the step of a task fails due to image not being pulled</p>
 </td>
+</tr><tr><td><p>&#34;TaskRunResultLargerThanAllowedLimit&#34;</p></td>
+<td><p>TaskRunReasonResultLargerThanAllowedLimit is the reason set when one of the results exceeds its maximum allowed limit of 1 KB</p>
+</td>
 </tr><tr><td><p>&#34;Running&#34;</p></td>
 <td><p>TaskRunReasonRunning is the reason set when the TaskRun is running</p>
 </td>
@@ -6347,15 +6350,17 @@ string
 <td>
 <code>kms</code><br/>
 <em>
-<a href="#tekton.dev/v1alpha1.HashAlgorithm">
-HashAlgorithm
-</a>
+string
 </em>
 </td>
 <td>
 <em>(Optional)</em>
 <p>KMS contains the KMS url of the public key
-Supported formats differ based on the KMS system used.</p>
+Supported formats differ based on the KMS system used.
+One example of a KMS url could be:
+gcpkms://projects/[PROJECT]/locations/[LOCATION]&gt;/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[KEY_VERSION]
+For more examples please refer <a href="https://docs.sigstore.dev/cosign/kms_support">https://docs.sigstore.dev/cosign/kms_support</a>.
+Note that the KMS is not supported yet.</p>
 </td>
 </tr>
 <tr>

diff --git a/pkg/reconciler/pipelinerun/tracing.go b/pkg/reconciler/pipelinerun/tracing.go
@@ -38,7 +38,7 @@ const (
 	TaskRunSpanContextAnnotation = "tekton.dev/taskrunSpanContext"
 )
 
-// initialize tracing by creating the root span and injecting the spanContext
+// initialize tracing by creating the root span and injecting the
 // spanContext is propogated through annotations in the CR
 func initTracing(ctx context.Context, tracerProvider trace.TracerProvider, pr *v1beta1.PipelineRun) context.Context {
 	logger := logging.FromContext(ctx)

diff --git a/pkg/reconciler/pipelinerun/tracing_test.go b/pkg/reconciler/pipelinerun/tracing_test.go
@@ -115,9 +115,6 @@ func TestInitTracing(t *testing.T) {
 					t.Errorf("invalid trace Id propagated, %s", parentID)
 				}
 			}
-
 		})
-
 	}
-
 }
diff --git a/pkg/reconciler/taskrun/tracing.go b/pkg/reconciler/taskrun/tracing.go
@@ -35,7 +35,7 @@ const (
 	SpanContextAnnotation = "tekton.dev/taskrunSpanContext"
 )
 
-// initialize tracing by creating the root span and injecting the spanContext
+// initialize tracing by creating the root span and injecting the
 // spanContext is propogated through annotations in the CR
 func initTracing(ctx context.Context, tracerProvider trace.TracerProvider, tr *v1beta1.TaskRun) context.Context {
 	logger := logging.FromContext(ctx)

diff --git a/pkg/reconciler/taskrun/tracing_test.go b/pkg/reconciler/taskrun/tracing_test.go
@@ -120,7 +120,5 @@ func TestInitTracing(t *testing.T) {
 				}
 			}
 		})
-
 	}
-
 }
-Original file line number
+Diff line change
@@ Expand Up / @@ -115,9 +115,6 @@ func TestInitTracing(t *testing.T) { @@
     					t.Errorf("invalid trace Id propagated, %s", parentID)
     				}
     			}
     		})
     	}
     }