Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document deprecation of the build-gcs PipelineResource type #3728

Merged
merged 1 commit into from
Jan 29, 2021
Merged

Document deprecation of the build-gcs PipelineResource type #3728

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/resources.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions docs/variables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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. |
Expand Down
2 changes: 2 additions & 0 deletions examples/v1alpha1/taskruns/build-gcs-targz.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 2 additions & 0 deletions examples/v1alpha1/taskruns/build-gcs-zip.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 2 additions & 0 deletions examples/v1beta1/taskruns/build-gcs-targz.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 2 additions & 0 deletions examples/v1beta1/taskruns/build-gcs-zip.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
1 change: 1 addition & 0 deletions pkg/apis/resource/v1alpha1/pipeline_resource_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
)

Expand Down