Document deprecation of the build-gcs PipelineResource type

tektoncd · Jan 29, 2021 · 14014b2 · 14014b2
1 parent 08177fa
commit 14014b2
Show file tree

Hide file tree

Showing 7 changed files with 17 additions and 1 deletion.
diff --git a/docs/resources.md b/docs/resources.md
@@ -933,7 +933,11 @@ service account.
 
 --------------------------------------------------------------------------------
 
-#### BuildGCS Storage Resource
+#### `Deprecated: `BuildGCS Storage Resource
+
+**NB:** This Resource type is _deprecated_, and will be removed in a future
+release. To fetch objects from Google Cloud Storage, prefer the [GCS storage
+resource](#gcs-storage-resource) instead.
 
 The `build-gcs` storage resource points to a
 [Google Cloud Storage](https://cloud.google.com/storage/) blob like

diff --git a/docs/variables.md b/docs/variables.md
@@ -95,6 +95,9 @@ variable via `resources.inputs.<resourceName>.<variableName>` or
 
 #### Variables for the  `BuildGCS` type
 
+**NB:** This Resource type is **Deprecated**. See [BuildGCS Storage
+Resource](./resources.md#buildgcs-storage-resource) for more information.
+
 | Variable | Description |
 | -------- | ----------- |
 | `name` | The name of the resource. |

diff --git a/examples/v1alpha1/taskruns/build-gcs-targz.yaml b/examples/v1alpha1/taskruns/build-gcs-targz.yaml
@@ -21,5 +21,7 @@ spec:
             value: gs://build-crd-tests/archive.tar.gz
           - name: artifactType
             value: TarGzArchive
+          # NB: The build-gcs PipelineResource type is deprecated, and will be
+          # removed in a future release.
           - name: type
             value: build-gcs
diff --git a/examples/v1alpha1/taskruns/build-gcs-zip.yaml b/examples/v1alpha1/taskruns/build-gcs-zip.yaml
@@ -21,5 +21,7 @@ spec:
             value: gs://build-crd-tests/archive.zip
           - name: artifactType
             value: ZipArchive
+          # NB: The build-gcs PipelineResource type is deprecated, and will be
+          # removed in a future release.
           - name: type
             value: build-gcs
diff --git a/examples/v1beta1/taskruns/build-gcs-targz.yaml b/examples/v1beta1/taskruns/build-gcs-targz.yaml
@@ -21,5 +21,7 @@ spec:
             value: gs://build-crd-tests/archive.tar.gz
           - name: artifactType
             value: TarGzArchive
+          # NB: The build-gcs PipelineResource type is deprecated, and will be
+          # removed in a future release.
           - name: type
             value: build-gcs
diff --git a/examples/v1beta1/taskruns/build-gcs-zip.yaml b/examples/v1beta1/taskruns/build-gcs-zip.yaml
@@ -21,5 +21,7 @@ spec:
             value: gs://build-crd-tests/archive.zip
           - name: artifactType
             value: ZipArchive
+          # NB: The build-gcs PipelineResource type is deprecated, and will be
+          # removed in a future release.
           - name: type
             value: build-gcs
diff --git a/pkg/apis/resource/v1alpha1/pipeline_resource_types.go b/pkg/apis/resource/v1alpha1/pipeline_resource_types.go
@@ -56,6 +56,7 @@ const (
 
 	// PipelineResourceTypeBuildGCS is the subtype for the BuildGCSResources, which is simialr to the GCSResource but
 	// with additional functionality that was added to be compatible with knative build.
+	// Deprecated: This PipelineResource type is deprecated and support will be removed in a future release.
 	PipelineResourceTypeBuildGCS PipelineResourceType = "build-gcs"
 )