From f4b56b1cfa71c78e1ea32278eb0f62732bd2e9d1 Mon Sep 17 00:00:00 2001 From: Priti Desai Date: Thu, 6 May 2021 14:06:24 -0700 Subject: [PATCH] Updating variables doc Adding a clear explaination for the context variable returning an aggregate status of the tasks section and updating toc in pipelines --- docs/pipelines.md | 10 ++++++---- docs/variables.md | 4 ++-- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/pipelines.md b/docs/pipelines.md index d5df23471cd..2fd49892435 100644 --- a/docs/pipelines.md +++ b/docs/pipelines.md @@ -31,10 +31,12 @@ weight: 3 - [Consuming `Task` execution results in `finally`](#consuming-task-execution-results-in-finally) - [`PipelineRun` Status with `finally`](#pipelinerun-status-with-finally) - [Using Execution `Status` of `pipelineTask`](#using-execution-status-of-pipelinetask) + - [Using Aggregate Execution `Status` of All `Tasks`](#using-aggregate-execution-status-of-all-tasks) - [Guard `Finally Task` execution using `WhenExpressions`](#guard-finally-task-execution-using-whenexpressions) - [`WhenExpressions` using `Parameters` in `Finally Tasks`](#whenexpressions-using-parameters-in-finally-tasks) - [`WhenExpressions` using `Results` in `Finally Tasks`](#whenexpressions-using-results-in-finally-tasks) - - [`WhenExpressions` using `Execution Status` of `PipelineTask` in `Finally Tasks`](#whenexpressions-using-execution-status-of-pipelinetask-in-finally-tasks) + - [`WhenExpressions` using `Execution Status` of `PipelineTask` in `Finally Tasks`](#whenexpressions-using-execution-status-of-pipelinetask-in-finally-tasks) + - [`WhenExpressions` using `Aggregate Execution Status` of `Tasks` in `Finally Tasks`](#whenexpressions-using-aggregate-execution-status-of-tasks-in-finally-tasks) - [Known Limitations](#known-limitations) - [Specifying `Resources` in Final Tasks](#specifying-resources-in-final-tasks) - [Cannot configure the Final Task execution order](#cannot-configure-the-final-task-execution-order) @@ -895,9 +897,9 @@ This kind of variable can have any one of the values from the following table: | Status | Description | | ------- | -----------| -| Succeeded | `taskRun` for the `pipelineTask` completed successfully | -| Failed | `taskRun` for the `pipelineTask` completed with a failure or cancelled by the user | -| None | the `pipelineTask` has been skipped or no execution information available for the `pipelineTask` | +| `Succeeded` | `taskRun` for the `pipelineTask` completed successfully | +| `Failed` | `taskRun` for the `pipelineTask` completed with a failure or cancelled by the user | +| `None` | the `pipelineTask` has been skipped or no execution information available for the `pipelineTask` | For an end-to-end example, see [`status` in a `PipelineRun`](../examples/v1beta1/pipelineruns/pipelinerun-task-execution-status.yaml). diff --git a/docs/variables.md b/docs/variables.md index b4293840eb6..1deccfcc3a1 100644 --- a/docs/variables.md +++ b/docs/variables.md @@ -23,8 +23,8 @@ For instructions on using variable substitutions see the relevant section of [th | `context.pipelineRun.namespace` | The namespace of the `PipelineRun` that this `Pipeline` is running in. | | `context.pipelineRun.uid` | The uid of the `PipelineRun` that this `Pipeline` is running in. | | `context.pipeline.name` | The name of this `Pipeline` . | -| `tasks..status` | The execution status of the specified `pipelineTask`, only available in `finally` tasks. | -| `tasks.status` | An aggregate status of all `tasks`, only available in `finally` tasks. | +| `tasks..status` | The execution status of the specified `pipelineTask`, only available in `finally` tasks. The execution status can be set to any one of the values (`Succeeded`, `Failed`, or `None`) described [here](pipelines.md#using-execution-status-of-pipelinetask)| +| `tasks.status` | An aggregate status of all the `pipelineTasks` under the `tasks` section (excluding the `finally` section). This variable is only available in the `finally` tasks and can have any one of the values (`Succeeded`, `Failed`, `Completed`, or `None`) described [here](pipelines.md#using-aggregate-execution-status-of-all-tasks). | ## Variables available in a `Task`