From e43c8de7ad24aa55f22b5a4f07540e7f88713227 Mon Sep 17 00:00:00 2001 From: Scott Date: Fri, 14 Feb 2020 15:43:32 -0500 Subject: [PATCH] Add a description field to pipeline workspace declarations A description field can help rationalize how a workspace will be used across multiple tasks in a pipeline without forcing the user to read and interpret the tasks themselves. This PR adds an optional description field to pipeline workspace declarations to help with this. --- pkg/apis/pipeline/v1alpha2/workspace_types.go | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/pkg/apis/pipeline/v1alpha2/workspace_types.go b/pkg/apis/pipeline/v1alpha2/workspace_types.go index a5082b98ed5..f9d85a7d55f 100644 --- a/pkg/apis/pipeline/v1alpha2/workspace_types.go +++ b/pkg/apis/pipeline/v1alpha2/workspace_types.go @@ -77,6 +77,11 @@ type WorkspaceBinding struct { type WorkspacePipelineDeclaration struct { // Name is the name of a workspace to be provided by a PipelineRun. Name string `json:"name"` + // Description is a human readable string describing how the workspace will be + // used in the Pipeline. It can be useful to include a bit of detail about which + // tasks are intended to have access to the data on the workspace. + // +optional + Description string `json:"description"` } // WorkspacePipelineTaskBinding describes how a workspace passed into the pipeline should be