Skip to content

Commit fff25b1

Browse files
HamzaMateentekton-robot
authored andcommitted
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. Fixes tektoncd#6908
1 parent 1335e0e commit fff25b1

File tree

9 files changed

+38
-38
lines changed

9 files changed

+38
-38
lines changed

docs/api-spec.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ List responses have the following fields (based on [`meta.v1/ListMeta`](https://
236236
| `name` | string | REQUIRED |
237237
| `description` | string | REQUIRED |
238238
| `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).|
240240
| `default` | `ParamValue` | REQUIRED |
241241

242242
### `ParamValue`
@@ -276,7 +276,7 @@ A `ParamValue` may be a string, a list of string, or a map of string to string.
276276
| `name` | string | REQUIRED |
277277
| `description` | string | REQUIRED |
278278
| `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).|
280280

281281
### `TaskRunResult`
282282

docs/auth.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ The following are considerations for executing `Runs` as a non-root user:
137137
the non-root user's valid home directory to use SSH authentication for either Git or Docker.
138138

139139
For an example of configuring SSH authentication in a non-root `securityContext`,
140-
see [`authenticating-git-commands`](../examples/v1beta1/taskruns/authenticating-git-commands.yaml).
140+
see [`authenticating-git-commands`](../examples/v1/taskruns/authenticating-git-commands.yaml).
141141

142142
## Limiting `Secret` access to specific `Steps`
143143

@@ -336,7 +336,7 @@ to the home directory of its associated user.
336336
**Note:** This explicit symlinking is not necessary when using the
337337
[`git-clone` `Task`](https://github.com/tektoncd/catalog/tree/v1beta1/git) from Tekton Catalog.
338338
339-
For example usage, see [`authenticating-git-commands`](../examples/v1beta1/taskruns/authenticating-git-commands.yaml).
339+
For example usage, see [`authenticating-git-commands`](../examples/v1/taskruns/authenticating-git-commands.yaml).
340340
341341
## Configuring authentication for Docker
342342

docs/developers/api-versioning.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -86,12 +86,12 @@ if err := ts.TestThing(ctx); err != nil {
8686

8787
Writing new YAML examples that require a feature gate to be set is easy. New
8888
YAML example files typically go in a directory called something like
89-
`examples/v1beta1/taskruns` in the root of the repo. To create a YAML that
89+
`examples/v1/taskruns` in the root of the repo. To create a YAML that
9090
should only be exercised when the `enable-api-fields` flag is `alpha` just put
9191
it in an `alpha` subdirectory so the structure looks like:
9292

9393
```
94-
examples/v1beta1/taskruns/alpha/your-example.yaml
94+
examples/v1/taskruns/alpha/your-example.yaml
9595
```
9696

9797
This should work for both taskruns and pipelineruns.

docs/matrix.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -849,6 +849,6 @@ status:
849849
```
850850

851851
[cel]: https://github.com/tektoncd/experimental/tree/1609827ea81d05c8d00f8933c5c9d6150cd36989/cel
852-
[pr-with-matrix]: ../examples/v1beta1/pipelineruns/alpha/pipelinerun-with-matrix.yaml
853-
[pr-with-matrix-and-results]: ../examples/v1beta1/pipelineruns/alpha/pipelinerun-with-matrix-and-results.yaml
852+
[pr-with-matrix]: ../examples/v1/pipelineruns/alpha/pipelinerun-with-matrix.yaml
853+
[pr-with-matrix-and-results]: ../examples/v1/pipelineruns/alpha/pipelinerun-with-matrix-and-results.yaml
854854
[retries]: pipelines.md#using-the-retries-field

docs/pipelineruns.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ spec:
104104
name: mytask
105105
```
106106

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)
108108
example displays morning and evening greetings. Once you create and execute it, you can check the logs for its `Pods`:
109109

110110
```bash
@@ -126,7 +126,7 @@ spec:
126126
steps: ...
127127
```
128128

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)
130130
it's `Tasks` all the way down!
131131

132132
You can also specify labels and annotations with `taskSpec` which are propagated to each `taskRun` and then to the
@@ -976,7 +976,7 @@ spec:
976976
For more information, see the following topics:
977977
- For information on mapping `Workspaces` to `Volumes`, see [Specifying `Workspaces` in `PipelineRuns`](workspaces.md#specifying-workspaces-in-pipelineruns).
978978
- 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).
980980

981981
[`Custom tasks`](pipelines.md#using-custom-tasks) may or may not use workspaces.
982982
Consult the documentation of the custom task that you are using to determine whether it supports workspaces.

docs/pipelines.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ spec:
182182

183183
For more information, see:
184184
- [Using `Workspaces` in `Pipelines`](workspaces.md#using-workspaces-in-pipelines)
185-
- The [`Workspaces` in a `PipelineRun`](../examples/v1beta1/pipelineruns/workspaces.yaml) code example
185+
- The [`Workspaces` in a `PipelineRun`](../examples/v1/pipelineruns/workspaces.yaml) code example
186186
- The [variables available in a `PipelineRun`](variables.md#variables-available-in-a-pipeline), including `workspaces.<name>.bound`.
187187
- [Mapping `Workspaces`](https://github.com/tektoncd/community/blob/main/teps/0108-mapping-workspaces.md)
188188

@@ -609,7 +609,7 @@ tasks:
609609
name: deployment
610610
```
611611

612-
For an end-to-end example, see [PipelineRun with `when` expressions](../examples/v1beta1/pipelineruns/pipelinerun-with-when-expressions.yaml).
612+
For an end-to-end example, see [PipelineRun with `when` expressions](../examples/v1/pipelineruns/pipelinerun-with-when-expressions.yaml).
613613

614614
There are a lot of scenarios where `when` expressions can be really useful. Some of these are:
615615
- Checking if the name of a git branch matches
@@ -863,7 +863,7 @@ performed by the Tekton Controller when a PipelineRun is executed.
863863
See the [complete list of variable substitutions for Pipelines](./variables.md#variables-available-in-a-pipeline)
864864
and the [list of fields that accept substitutions](./variables.md#fields-that-accept-variable-substitutions).
865865
866-
For an end-to-end example, see [using context variables](../examples/v1beta1/pipelineruns/using_context_variables.yaml).
866+
For an end-to-end example, see [using context variables](../examples/v1/pipelineruns/using_context_variables.yaml).
867867
868868
### Using the `retries` and `retry-count` variable substitutions
869869

@@ -961,7 +961,7 @@ when:
961961
values: ["yes"]
962962
```
963963

964-
For an end-to-end example, see [`Task` `Results` in a `PipelineRun`](../examples/v1beta1/pipelineruns/task_results_example.yaml).
964+
For an end-to-end example, see [`Task` `Results` in a `PipelineRun`](../examples/v1/pipelineruns/task_results_example.yaml).
965965

966966
Note that `when` expressions are whitespace-sensitive. In particular, when producing results intended for inputs to `when`
967967
expressions that may include newlines at their close (e.g. `cat`, `jq`), you may wish to truncate them.
@@ -1002,10 +1002,10 @@ results:
10021002
value: $(tasks.calculate-sum.results.outputValue)
10031003
```
10041004

1005-
For an end-to-end example, see [`Results` in a `PipelineRun`](../examples/v1beta1/pipelineruns/pipelinerun-results.yaml).
1005+
For an end-to-end example, see [`Results` in a `PipelineRun`](../examples/v1/pipelineruns/pipelinerun-results.yaml).
10061006

10071007
Object result and array result are beta features,
1008-
see [`Array and Object Results` in a `PipelineRun`](../examples/v1beta1/pipelineruns/beta/pipeline-emitting-results.yaml).
1008+
see [`Array and Object Results` in a `PipelineRun`](../examples/v1/pipelineruns/beta/pipeline-emitting-results.yaml).
10091009

10101010
```yaml
10111011
results:
@@ -1339,7 +1339,7 @@ This kind of variable can have any one of the values from the following table:
13391339
| `Failed` | `taskRun` for the `pipelineTask` completed with a failure or cancelled by the user |
13401340
| `None` | the `pipelineTask` has been skipped or no execution information available for the `pipelineTask` |
13411341

1342-
For an end-to-end example, see [`status` in a `PipelineRun`](../examples/v1beta1/pipelineruns/pipelinerun-task-execution-status.yaml).
1342+
For an end-to-end example, see [`status` in a `PipelineRun`](../examples/v1/pipelineruns/pipelinerun-task-execution-status.yaml).
13431343

13441344
### Using Aggregate Execution `Status` of All `Tasks`
13451345

@@ -1373,7 +1373,7 @@ This kind of variable can have any one of the values from the following table:
13731373
| `Completed` | all `tasks` completed successfully including one or more skipped tasks |
13741374
| `None` | no aggregate execution status available (i.e. none of the above), one or more `tasks` could be pending/running/cancelled/timedout |
13751375

1376-
For an end-to-end example, see [`$(tasks.status)` usage in a `Pipeline`](../examples/v1beta1/pipelineruns/pipelinerun-task-execution-status.yaml).
1376+
For an end-to-end example, see [`$(tasks.status)` usage in a `Pipeline`](../examples/v1/pipelineruns/pipelinerun-task-execution-status.yaml).
13771377

13781378
### Guard `finally` `Task` execution using `when` expressions
13791379

@@ -1486,7 +1486,7 @@ spec:
14861486
# […]
14871487
```
14881488

1489-
For an end-to-end example, see [PipelineRun with `when` expressions](../examples/v1beta1/pipelineruns/pipelinerun-with-when-expressions.yaml).
1489+
For an end-to-end example, see [PipelineRun with `when` expressions](../examples/v1/pipelineruns/pipelinerun-with-when-expressions.yaml).
14901490

14911491
#### `when` expressions using `Aggregate Execution Status` of `Tasks` in `finally` `tasks`
14921492

@@ -1504,7 +1504,7 @@ finally:
15041504
name: notify-failure
15051505
```
15061506

1507-
For an end-to-end example, see [PipelineRun with `when` expressions](../examples/v1beta1/pipelineruns/pipelinerun-with-when-expressions.yaml).
1507+
For an end-to-end example, see [PipelineRun with `when` expressions](../examples/v1/pipelineruns/pipelinerun-with-when-expressions.yaml).
15081508

15091509
### Known Limitations
15101510

docs/taskruns.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -501,7 +501,7 @@ workspaces:
501501
For more information, see the following topics:
502502
- For information on mapping `Workspaces` to `Volumes`, see [Using `Workspace` variables in `TaskRuns`](workspaces.md#using-workspace-variables-in-taskruns).
503503
- 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).
505505

506506
#### Propagated Workspaces
507507

@@ -1092,7 +1092,7 @@ spec:
10921092

10931093
If a Task step specifies that it is to run as a different user than what is specified in the pod template,
10941094
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).
10961096

10971097
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).
10981098

docs/tasks.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -429,8 +429,8 @@ kubectl get tr taskrun-unit-test-t6qcl -o json | jq .status
429429
],
430430
```
431431
432-
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).
434434
435435
#### Accessing Step's `exitCode` in subsequent `Steps`
436436
@@ -588,13 +588,13 @@ spec:
588588
type: string
589589
```
590590

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.
592592

593593
> NOTE:
594594
> - `object` param is a `beta` feature and gated by the `alpha` or `beta` feature flag.
595595
> - `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).
598598

599599
##### `array` type
600600

@@ -694,7 +694,7 @@ spec:
694694
#### Default value
695695
Parameter declarations (within Tasks and Pipelines) can include default values which will be used if the parameter is
696696
not specified, for example to specify defaults for both string params and array params
697-
([full example](../examples/v1beta1/taskruns/array-default.yaml)) :
697+
([full example](../examples/v1/taskruns/array-default.yaml)) :
698698
699699
```yaml
700700
apiVersion: tekton.dev/v1 # or tekton.dev/v1beta1
@@ -734,7 +734,7 @@ spec:
734734
```
735735

736736
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.
738738

739739
### Propagated `Workspaces`
740740

@@ -1542,7 +1542,7 @@ specified at the pod level via the TaskRun `podTemplate`.
15421542

15431543
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).
15441544

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).
15461546

15471547
## `Task` Authoring Recommendations
15481548

0 commit comments

Comments
 (0)