From e16b6c72ff89af207ee3cf10aaa869b4306b3ff6 Mon Sep 17 00:00:00 2001 From: Olivier Thomann Date: Thu, 23 Jan 2020 16:39:08 -0500 Subject: [PATCH] Fix reviews --- docs/taskruns.md | 6 ++++-- docs/tasks.md | 6 +++--- pkg/apis/pipeline/v1alpha1/taskrun_types.go | 7 ++++--- 3 files changed, 11 insertions(+), 8 deletions(-) diff --git a/docs/taskruns.md b/docs/taskruns.md index 3e00f818022..82bec934113 100644 --- a/docs/taskruns.md +++ b/docs/taskruns.md @@ -346,7 +346,7 @@ If multiple `steps` are defined in the `Task` invoked by the `TaskRun`, we will ### Results -If one or more `results` are defined in the `Task` invoked by the `TaskRun`, we will get an new entry +If one or more `results` are defined in the `Task` invoked by the `TaskRun`, we will get a new entry `Task Results` added to the status. Here is an example: @@ -364,6 +364,8 @@ Status: ``` +Results will be printed verbatim; any new lines or other whitespace returned as part of the result will be included in the output. + ## Cancelling a TaskRun In order to cancel a running task (`TaskRun`), you need to update its spec to @@ -688,7 +690,7 @@ Note: There are some known issues with the existing implementation of sidecars: - The configured "nop" image must not provide the command that the sidecar is expected to run. If it does provide the command then it will not exit. This will result in the sidecar running forever and the Task -eventually timing out. +eventually timing out. [This bug is being tracked in issue 1347](https://github.com/tektoncd/pipeline/issues/1347) is the issue where this bug is being tracked. - `kubectl get pods` will show a TaskRun's Pod as "Completed" if a sidecar diff --git a/docs/tasks.md b/docs/tasks.md index 3f5f0c643e3..4bead63b1c0 100644 --- a/docs/tasks.md +++ b/docs/tasks.md @@ -378,7 +378,7 @@ spec: - name: current-date-unix-timestamp description: The current date in unix timestamp format - name: current-date-human-readable - description: The current date in humand readable format + description: The current date in human readable format steps: - name: print-date-unix-timestamp image: bash:latest @@ -539,7 +539,7 @@ is configurable using a flag of the Tekton controller. If the configured "nop" image contains the command that the sidecar was running before the sidecar was stopped then the sidecar will actually keep running, causing the TaskRun's Pod to remain running, and eventually causing the TaskRun to timeout rather -then exit successfully. Issue +then exit successfully. [Issue 1347](https://github.com/tektoncd/pipeline/issues/1347) has been created to track this bug. ### Variable Substitution @@ -547,7 +547,7 @@ has been created to track this bug. `Tasks` support string replacement using values from: - [Inputs and Outputs](#input-and-output-substitution) -- [Array params](#variable-substitution-with-parameters-of-type-array) + - [Array params](#variable-substitution-with-parameters-of-type-array) - [`workspaces`](#variable-substitution-with-workspaces) - [`volumes`](#variable-substitution-with-volumes) diff --git a/pkg/apis/pipeline/v1alpha1/taskrun_types.go b/pkg/apis/pipeline/v1alpha1/taskrun_types.go index e4f48b0d9f4..c8601e0d849 100644 --- a/pkg/apis/pipeline/v1alpha1/taskrun_types.go +++ b/pkg/apis/pipeline/v1alpha1/taskrun_types.go @@ -131,13 +131,14 @@ type TaskRunStatusFields struct { // All TaskRunStatus stored in RetriesStatus will have no date within the RetriesStatus as is redundant. // +optional RetriesStatus []TaskRunStatus `json:"retriesStatus,omitempty"` + // Results from Resources built during the taskRun. currently includes // the digest of build container images - // optional + // +optional ResourcesResult []PipelineResourceResult `json:"resourcesResult,omitempty"` - // TaskRunResult from task runs - // optional + // TaskRunResults are the list of results written out by the task's containers + // +optional TaskRunResults []TaskRunResult `json:"taskResults,omitempty"` // The list has one entry per sidecar in the manifest. Each entry is