Skip to content

Commit afb2833

Browse files
Yongxuanzhangtekton-robot
authored andcommitted
Remove not supported results and params variables doc
This commit updates the results and params related variables doc. In the doc for results, the square bracket reference is not currently supported for all types of results, these should be removed to avoid user confusion before issue tektoncd#4910 is done. Meanwhile we add star notation for param reference as a whole.
1 parent 28c829f commit afb2833

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

docs/variables.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,21 +19,16 @@ For instructions on using variable substitutions see the relevant section of [th
1919
| `params.<param name>` | The value of the parameter at runtime. |
2020
| `params['<param name>']` | (see above) |
2121
| `params["<param name>"]` | (see above) |
22+
| `params.<param name>[*]` | Get the whole param array or object.|
23+
| `params['<param name>'][*]` | (see above) |
24+
| `params["<param name>"][*]` | (see above) |
2225
| `params.<param name>[i]` | Get the i-th element of param array. This is alpha feature, set `enable-api-fields` to `alpha` to use it.|
2326
| `params['<param name>'][i]` | (see above) |
2427
| `params["<param name>"][i]` | (see above) |
2528
| `tasks.<taskName>.results.<resultName>` | The value of the `Task's` result. Can alter `Task` execution order within a `Pipeline`.) |
26-
| `tasks.<taskName>.results['<resultName>']` | (see above)) |
27-
| `tasks.<taskName>.results["<resultName>"]` | (see above)) |
2829
| `tasks.<taskName>.results.<resultName>[i]` | The ith value of the `Task's` array result. Can alter `Task` execution order within a `Pipeline`.) |
29-
| `tasks.<taskName>.results['<resultName>'][i]` | (see above)) |
30-
| `tasks.<taskName>.results["<resultName>"][i]` | (see above)) |
3130
| `tasks.<taskName>.results.<resultName>[*]` | The array value of the `Task's` result. Can alter `Task` execution order within a `Pipeline`. Cannot be used in `script`.) |
32-
| `tasks.<taskName>.results['<resultName>'][*]` | (see above)) |
33-
| `tasks.<taskName>.results["<resultName>"][*]` | (see above)) |
3431
| `tasks.<taskName>.results.<resultName>.key` | The `key` value of the `Task's` object result. Can alter `Task` execution order within a `Pipeline`.) |
35-
| `tasks.<taskName>.results['<resultName>'][key]` | (see above)) |
36-
| `tasks.<taskName>.results["<resultName>"][key]` | (see above)) |
3732
| `workspaces.<workspaceName>.bound` | Whether a `Workspace` has been bound or not. "false" if the `Workspace` declaration has `optional: true` and the Workspace binding was omitted by the PipelineRun. |
3833
| `context.pipelineRun.name` | The name of the `PipelineRun` that this `Pipeline` is running in. |
3934
| `context.pipelineRun.namespace` | The namespace of the `PipelineRun` that this `Pipeline` is running in. |
@@ -50,6 +45,9 @@ For instructions on using variable substitutions see the relevant section of [th
5045
| `params.<param name>` | The value of the parameter at runtime. |
5146
| `params['<param name>']` | (see above) |
5247
| `params["<param name>"]` | (see above) |
48+
| `params.<param name>[*]` | Get the whole param array or object.|
49+
| `params['<param name>'][*]` | (see above) |
50+
| `params["<param name>"][*]` | (see above) |
5351
| `params.<param name>[i]` | Get the i-th element of param array. This is alpha feature, set `enable-api-fields` to `alpha` to use it.|
5452
| `params['<param name>'][i]` | (see above) |
5553
| `params["<param name>"][i]` | (see above) |

0 commit comments

Comments
 (0)