Add a description field to pipeline workspace declarations #2054
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
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. I would personally like this support to help when writing
example pipelines for catalog tasks. e.g. https://github.com/tektoncd/catalog/pull/182/files#diff-eee548fe380dc59c94cc87563f0d454cR82
Submitter Checklist
These are the criteria that every PR should meet, please check them off as you
review them:
Includes tests (if functionality changed/added)See the contribution guide for more details.
Double check this list of stuff that's easy to miss:
cmd
dir, please updatethe release Task to build and release this image.
Reviewer Notes
If API changes are included, additive changes must be approved by at least two OWNERS and backwards incompatible changes must be approved by more than 50% of the OWNERS, and they must first be added in a backwards compatible way.
Release Notes