Pipeline: Add description field to Resources in Tasks

[bobcatfish]

Expected Behavior

It should be easy to tell from looking at a Task what the intended usage is of any PipelineResources the Task requires.

Actual Behavior

We have description fields for params but not for input or output PipelineResources, for exmaple the kaniko Task from the catalog:

  inputs:
    params:
    - name: DOCKERFILE
      description: Path to the Dockerfile to build.
      default: ./Dockerfile
    - name: CONTEXT
      description: The build context used by Kaniko.
      default: ./
    resources:
    - name: source
      type: git
  outputs:
    resources:
    - name: image
      type: image

Additional Info

Related issue about creating a tool to display documentation (which would need fields like this): https://github.com/tektoncd/catalog/issues/7

[toshi0607]

Is adding Description to Inputs and Outputs type in v1alpha/task_types.go right way to solve this issue? If it's not wrong approach, may I challenge this?

[skaegi]

I'm hoping we could add something like ParamSpec Description to
ResourceDeclaration

[3sky]

OK, let's begin /assign it to me.

[toshi0607]

/assign @toshi0607

[vdemeester]

1875 got merged so I think we can safely close

/close

[tekton-robot]

@vdemeester: Closing this issue.

In response to this:

1875 got merged so I think we can safely close

/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.