Docs update(fixed links) as per review feedback.

tektoncd · May 25, 2021 · 6626be3 · 6626be3
1 parent c6196b9
commit 6626be3
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 5 deletions.
diff --git a/docs/pipelines.md b/docs/pipelines.md
@@ -1201,6 +1201,9 @@ If the `taskSpec` is not supported, the custom task controller should produce pr
 Please take a look at the
 [developer guide for custom controllers supporting `taskSpec`.](runs.md#developer-guide-for-custom-controllers-supporting-spec)
 
+`taskSpec` support for `pipelineRun` was designed and discussed in
+[TEP-0061](https://github.com/tektoncd/community/blob/main/teps/0061-allow-custom-task-to-be-embedded-in-pipeline.md)
+
 ### Specifying parameters
 
 If a custom task supports [`parameters`](tasks.md#parameters), you can use the

diff --git a/docs/runs.md b/docs/runs.md
@@ -47,10 +47,10 @@ A `Run` definition supports the following fields:
   - [`metadata`][kubernetes-overview] - Specifies the metadata that uniquely identifies the
     `Run`, such as a `name`.
   - [`spec`][kubernetes-overview] - Specifies the configuration for the `Run`.
-    - [`ref`](#specifying-the-target-custom-task-with-ref) - Specifies the type and
+    - [`ref`](#1-specifying-the-target-custom-task-with-ref) - Specifies the type and
       (optionally) name of the custom task type to execute.
-    - [`spec`](#specifying-the-target-custom-task-by-embedding-its-spec) - 
-      Embed the custom task resource spec directly in a `Run`.
+    - [`spec`](#2-specifying-the-target-custom-task-by-embedding-its-spec) - Embed the custom task resource spec
+      directly in a `Run`.
 - Optional:
   - [`params`](#specifying-parameters) - Specifies the desired execution
     parameters for the custom task.
@@ -69,10 +69,10 @@ A `Run` definition supports the following fields:
 A custom task resource's `Spec` may be directly embedded in the `Run` or it may
 be referred to by a `Ref`. But, not both at the same time.
 
-1. [Specifying the target Custom Task with ref](#specifying-the-target-custom-task-with-ref)
+1. [Specifying the target Custom Task with ref](#1-specifying-the-target-custom-task-with-ref)
    Referring a custom task (i.e. `Ref` ) promotes reuse of custom task definitions.
 
-2. [Specifying the target Custom Task by embedding its spec](#specifying-the-target-custom-task-by-embedding-its-spec)
+2. [Specifying the target Custom Task by embedding its spec](#2-specifying-the-target-custom-task-by-embedding-its-spec)
    Embedding a custom task (i.e. `Spec` ) helps in avoiding name collisions with other users within the same namespace.
    Additionally, in a pipeline with multiple embedded custom tasks, the details of entire pipeline can be fetched in a
    single API request.

diff --git a/pkg/reconciler/pipelinerun/pipelinerun_test.go b/pkg/reconciler/pipelinerun/pipelinerun_test.go
@@ -542,6 +542,7 @@ func TestReconcile_CustomTask(t *testing.T) {
 								APIVersion: "example.dev/v0",
 								Kind:       "Example",
 							},
+							Metadata: v1beta1.PipelineTaskMetadata{Labels: map[string]string{"test-label": "test"}},
 							Spec: runtime.RawExtension{
 								Raw: []byte(`{"field1":123,"field2":"value"}`),
 							},
@@ -578,6 +579,7 @@ func TestReconcile_CustomTask(t *testing.T) {
 						APIVersion: "example.dev/v0",
 						Kind:       "Example",
 					},
+					Metadata: v1beta1.PipelineTaskMetadata{Labels: map[string]string{"test-label": "test"}},
 					Spec: runtime.RawExtension{
 						Raw: []byte(`{"field1":123,"field2":"value"}`),
 					},