Deprecate ClusterTasks

This commit marks ClusterTasks as deprecated, planned for the next Pipelines release.
tektoncd · Sep 22, 2022 · db8ffae · db8ffae
1 parent 34274fb
commit db8ffae
Show file tree

Hide file tree

Showing 8 changed files with 12 additions and 3 deletions.
diff --git a/docs/deprecations.md b/docs/deprecations.md
@@ -23,3 +23,4 @@ being deprecated.
 | [The `PipelineRun.Status.TaskRuns` and `PipelineRun.Status.Runs` fields are deprecated and will be removed.](https://github.com/tektoncd/community/blob/main/teps/0100-embedded-taskruns-and-runs-status-in-pipelineruns.md) | v0.35.0                                                              | Beta                                                                                                   | Jan 25, 2023                        |
 | [PipelineRun.Timeout is deprecated and will be removed](https://github.com/tektoncd/community/blob/main/teps/0046-finallytask-execution-post-timeout.md)                                                                     | v0.36.0                                                              | Beta                                                                                                   | Feb 25, 2023                        |
 | [Several fields of Task.Step are deprecated](https://github.com/tektoncd/pipeline/issues/4737)                                                                                                                               | v0.36.0                                                              | Beta                                                                                                   | Feb 25, 2023                        |
+| [ClusterTask is deprecated](https://github.com/tektoncd/pipeline/issues/4476)                                                                                                                               | v0.41.0                                                              | Beta                                                                                                   | July 13, 2023                        |
diff --git a/docs/tasks.md b/docs/tasks.md
@@ -129,6 +129,8 @@ spec:
 
 ### `Task` vs. `ClusterTask`
 
+**Note: ClusterTasks are deprecated.** Please use the [cluster resolver](./cluster-resolver.md) instead.
+
 A `ClusterTask` is a `Task` scoped to the entire cluster instead of a single namespace.
 A `ClusterTask` behaves identically to a `Task` and therefore everything in this document
 applies to both.

diff --git a/examples/v1beta1/pipelineruns/clustertask-pipelinerun.yaml b/examples/v1beta1/pipelineruns/clustertask-pipelinerun.yaml
@@ -1,3 +1,5 @@
+# Note: ClusterTasks are deprecated. Please use the cluster resolver instead.
+# https://github.com/tektoncd/pipeline/blob/main/docs/cluster-resolver.md
 apiVersion: tekton.dev/v1beta1
 kind: ClusterTask
 metadata:

diff --git a/examples/v1beta1/taskruns/clustertask.yaml b/examples/v1beta1/taskruns/clustertask.yaml
@@ -1,3 +1,5 @@
+# Note: ClusterTasks are deprecated. Please use the cluster resolver instead.
+# https://github.com/tektoncd/pipeline/blob/main/docs/cluster-resolver.md
 apiVersion: tekton.dev/v1beta1
 kind: ClusterTask
 metadata:

diff --git a/examples/v1beta1/taskruns/optional-resources-with-clustertask.yaml b/examples/v1beta1/taskruns/optional-resources-with-clustertask.yaml
@@ -1,3 +1,5 @@
+# Note: ClusterTasks are deprecated. Please use the cluster resolver instead.
+# https://github.com/tektoncd/pipeline/blob/main/docs/cluster-resolver.md
 apiVersion: tekton.dev/v1beta1
 kind: ClusterTask
 metadata:

diff --git a/pkg/apis/pipeline/v1beta1/cluster_task_types.go b/pkg/apis/pipeline/v1beta1/cluster_task_types.go
@@ -31,7 +31,7 @@ import (
 
 // ClusterTask is a Task with a cluster scope. ClusterTasks are used to
 // represent Tasks that should be publicly addressable from any namespace in the
-// cluster.
+// cluster. Deprecated: Please use the cluster resolver instead.
 type ClusterTask struct {
 	metav1.TypeMeta `json:",inline"`
 	// +optional

diff --git a/pkg/apis/pipeline/v1beta1/openapi_generated.go b/pkg/apis/pipeline/v1beta1/openapi_generated.go
diff --git a/pkg/apis/pipeline/v1beta1/swagger.json b/pkg/apis/pipeline/v1beta1/swagger.json
@@ -501,7 +501,7 @@
       }
     },
     "v1beta1.ClusterTask": {
-      "description": "ClusterTask is a Task with a cluster scope. ClusterTasks are used to represent Tasks that should be publicly addressable from any namespace in the cluster.",
+      "description": "ClusterTask is a Task with a cluster scope. ClusterTasks are used to represent Tasks that should be publicly addressable from any namespace in the cluster. Deprecated: Please use the cluster resolver instead.",
       "type": "object",
       "properties": {
         "apiVersion": {