You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: Update references to examples from v1beta1 to v1
In response to the cleanup effort aimed at deduplicating tests between v1 and v1beta1,
this commit addresses broken links in our documentation. The changes involve updating
references to examples under the v1beta1 API version to instead point to the v1 API version.
Additionally, certain features that transitioned from alpha to beta within the v1 API required
corresponding updates to their references.
This change ensures that the documentation accurately reflects the current state of the project,
eliminating broken links and inconsistencies. The goal is to improve the overall user experience
and provide accurate information.
Fixestektoncd#6908
Copy file name to clipboardExpand all lines: docs/api-spec.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -236,7 +236,7 @@ List responses have the following fields (based on [`meta.v1/ListMeta`](https://
236
236
|`name`| string | REQUIRED |
237
237
|`description`| string | REQUIRED |
238
238
|`type`| Enum:<br>- `"string"` (default)<br>- `"array"` <br>- `"object"`| REQUIRED (The values `string` and `array` for this field are REQUIRED, and the value `object` is RECOMMENDED.) |
239
-
|`properties`| map<string,PropertySpec> |RECOMMENDED <br><br>note: `PropertySpec` is a type that defines the spec of an individual key. See how to define the `properties` section in the [example](../examples/v1beta1/taskruns/alpha/object-param-result.yaml).|
239
+
|`properties`| map<string,PropertySpec> |RECOMMENDED <br><br>note: `PropertySpec` is a type that defines the spec of an individual key. See how to define the `properties` section in the [example](../examples/v1/taskruns/beta/object-param-result.yaml).|
240
240
|`default`|`ParamValue`| REQUIRED |
241
241
242
242
### `ParamValue`
@@ -276,7 +276,7 @@ A `ParamValue` may be a string, a list of string, or a map of string to string.
276
276
|`name`| string | REQUIRED |
277
277
|`description`| string | REQUIRED |
278
278
|`type`| Enum:<br>- `"string"` (default)<br>- `"array"` <br>- `"object"`| RECOMMENDED (Each of the values is RECOMMENDED.)|
279
-
|`properties`| map<string,PropertySpec> | RECOMMENDED <br><br>note: `PropertySpec` is a type that defines the spec of an individual key. See how to define the `properties` section in the [example](../examples/v1beta1/taskruns/alpha/object-param-result.yaml).|
279
+
|`properties`| map<string,PropertySpec> | RECOMMENDED <br><br>note: `PropertySpec` is a type that defines the spec of an individual key. See how to define the `properties` section in the [example](../examples/v1/taskruns/beta/object-param-result.yaml).|
Copy file name to clipboardExpand all lines: docs/pipelineruns.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -104,7 +104,7 @@ spec:
104
104
name: mytask
105
105
```
106
106
107
-
The `Pipeline` in the [`pipelineSpec` example](../examples/v1beta1/pipelineruns/pipelinerun-with-pipelinespec.yaml)
107
+
The `Pipeline` in the [`pipelineSpec` example](../examples/v1/pipelineruns/pipelinerun-with-pipelinespec.yaml)
108
108
example displays morning and evening greetings. Once you create and execute it, you can check the logs for its `Pods`:
109
109
110
110
```bash
@@ -126,7 +126,7 @@ spec:
126
126
steps: ...
127
127
```
128
128
129
-
In the [`taskSpec` in `pipelineSpec` example](../examples/v1beta1/pipelineruns/pipelinerun-with-pipelinespec-and-taskspec.yaml)
129
+
In the [`taskSpec` in `pipelineSpec` example](../examples/v1/pipelineruns/pipelinerun-with-pipelinespec-and-taskspec.yaml)
130
130
it's `Tasks` all the way down!
131
131
132
132
You can also specify labels and annotations with `taskSpec` which are propagated to each `taskRun` and then to the
@@ -976,7 +976,7 @@ spec:
976
976
For more information, see the following topics:
977
977
- For information on mapping `Workspaces` to `Volumes`, see [Specifying `Workspaces` in `PipelineRuns`](workspaces.md#specifying-workspaces-in-pipelineruns).
978
978
- For a list of supported `Volume` types, see [Specifying `VolumeSources` in `Workspaces`](workspaces.md#specifying-volumesources-in-workspaces).
979
-
- For an end-to-end example, see [`Workspaces` in a `PipelineRun`](../examples/v1beta1/pipelineruns/workspaces.yaml).
979
+
- For an end-to-end example, see [`Workspaces` in a `PipelineRun`](../examples/v1/pipelineruns/workspaces.yaml).
980
980
981
981
[`Custom tasks`](pipelines.md#using-custom-tasks) may or may not use workspaces.
982
982
Consult the documentation of the custom task that you are using to determine whether it supports workspaces.
Copy file name to clipboardExpand all lines: docs/taskruns.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -501,7 +501,7 @@ workspaces:
501
501
For more information, see the following topics:
502
502
- For information on mapping `Workspaces` to `Volumes`, see [Using `Workspace` variables in `TaskRuns`](workspaces.md#using-workspace-variables-in-taskruns).
503
503
- For a list of supported `Volume` types, see [Specifying `VolumeSources` in `Workspaces`](workspaces.md#specifying-volumesources-in-workspaces).
504
-
- For an end-to-end example, see [`Workspaces` in a `TaskRun`](../examples/v1beta1/taskruns/workspace.yaml).
504
+
- For an end-to-end example, see [`Workspaces` in a `TaskRun`](../examples/v1/taskruns/workspace.yaml).
505
505
506
506
#### Propagated Workspaces
507
507
@@ -1092,7 +1092,7 @@ spec:
1092
1092
1093
1093
If a Task step specifies that it is to run as a different user than what is specified in the pod template,
1094
1094
the step's `securityContext` will be applied instead of what is specified at the pod level. An example of
1095
-
this is available as a [TaskRun example](../examples/v1beta1/taskruns/run-steps-as-non-root.yaml).
1095
+
this is available as a [TaskRun example](../examples/v1/taskruns/run-steps-as-non-root.yaml).
1096
1096
1097
1097
More information about Pod and Container Security Contexts can be found via the [Kubernetes website](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod).
For an end-to-end example, see [the taskRun ignoring a step error](../examples/v1beta1/taskruns/ignore-step-error.yaml)
433
-
and [the pipelineRun ignoring a step error](../examples/v1beta1/pipelineruns/ignore-step-error.yaml).
432
+
For an end-to-end example, see [the taskRun ignoring a step error](../examples/v1/taskruns/ignore-step-error.yaml)
433
+
and [the pipelineRun ignoring a step error](../examples/v1/pipelineruns/ignore-step-error.yaml).
434
434
435
435
#### Accessing Step's `exitCode` in subsequent `Steps`
436
436
@@ -588,13 +588,13 @@ spec:
588
588
type: string
589
589
```
590
590
591
-
Refer to the [TaskRun example](../examples/v1beta1/taskruns/alpha/object-param-result.yaml) and the [PipelineRun example](../examples/v1beta1/pipelineruns/alpha/pipeline-object-param-and-result.yaml) in which `object` parameters are demonstrated.
591
+
Refer to the [TaskRun example](../examples/v1/taskruns/beta/object-param-result.yaml) and the [PipelineRun example](../examples/v1/pipelineruns/beta/pipeline-object-param-and-result.yaml) in which `object` parameters are demonstrated.
592
592
593
593
> NOTE:
594
594
> - `object` param is a `beta` feature and gated by the `alpha` or `beta` feature flag.
595
595
> - `object` param must specify the `properties` section to define the schema i.e. what keys are available for this object param. See how to define `properties` section in the following example and the [TEP-0075](https://github.com/tektoncd/community/blob/main/teps/0075-object-param-and-result-types.md#defaulting-to-string-types-for-values).
596
-
> - When providing value for an `object` param, one may provide values for just a subset of keys in spec's `default`, and provide values for the rest of keys at runtime ([example](../examples/v1beta1/taskruns/beta/object-param-result.yaml)).
597
-
> - When using object in variable replacement, users can only access its individual key ("child" member) of the object by its name i.e. `$(params.gitrepo.url)`. Using an entire object as a value is only allowed when the value is also an object like [this example](https://github.com/tektoncd/pipeline/blob/55665765e4de35b3a4fb541549ae8cdef0996641/examples/v1beta1/pipelineruns/beta/pipeline-object-param-and-result.yaml#L64-L65). See more details about using object param from the [TEP-0075](https://github.com/tektoncd/community/blob/main/teps/0075-object-param-and-result-types.md#using-objects-in-variable-replacement).
596
+
> - When providing value for an `object` param, one may provide values for just a subset of keys in spec's `default`, and provide values for the rest of keys at runtime ([example](../examples/v1/taskruns/beta/object-param-result.yaml)).
597
+
> - When using object in variable replacement, users can only access its individual key ("child" member) of the object by its name i.e. `$(params.gitrepo.url)`. Using an entire object as a value is only allowed when the value is also an object like [this example](https://github.com/tektoncd/pipeline/blob/55665765e4de35b3a4fb541549ae8cdef0996641/examples/v1/pipelineruns/beta/pipeline-object-param-and-result.yaml#L64-L65). See more details about using object param from the [TEP-0075](https://github.com/tektoncd/community/blob/main/teps/0075-object-param-and-result-types.md#using-objects-in-variable-replacement).
598
598
599
599
##### `array` type
600
600
@@ -694,7 +694,7 @@ spec:
694
694
#### Default value
695
695
Parameter declarations (within Tasks and Pipelines) can include default values which will be used if the parameter is
696
696
not specified, for example to specify defaults for both string params and array params
For more information, see [Using `Workspaces` in `Tasks`](workspaces.md#using-workspaces-in-tasks)
737
-
and the [`Workspaces` in a `TaskRun`](../examples/v1beta1/taskruns/workspace.yaml) example YAML file.
737
+
and the [`Workspaces` in a `TaskRun`](../examples/v1/taskruns/workspace.yaml) example YAML file.
738
738
739
739
### Propagated `Workspaces`
740
740
@@ -1542,7 +1542,7 @@ specified at the pod level via the TaskRun `podTemplate`.
1542
1542
1543
1543
More information about Pod and Container Security Contexts can be found via the [Kubernetes website](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod).
1544
1544
1545
-
The example Task/TaskRun above can be found as a [TaskRun example](../examples/v1beta1/taskruns/run-steps-as-non-root.yaml).
1545
+
The example Task/TaskRun above can be found as a [TaskRun example](../examples/v1/taskruns/run-steps-as-non-root.yaml).
0 commit comments