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.

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

Add a description field to pipeline workspace declarations #2054

Merged
merged 1 commit into from Feb 14, 2020
Merged

Add a description field to pipeline workspace declarations #2054

merged 1 commit into from Feb 14, 2020

Conversation

ghost
Copy link

@ghost ghost commented Feb 14, 2020

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:

See the contribution guide for more details.

Double check this list of stuff that's easy to miss:

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

You can now include a description as part of your pipeline's workspace declarations to help users figure out how their volumes will be used in the pipeline.

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.
@googlebot googlebot added the cla: yes Trying to make the CLA bot happy with ppl from different companies work on one commit label Feb 14, 2020
@tekton-robot tekton-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Feb 14, 2020
Copy link
Member

@dibyom dibyom left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Feb 14, 2020
@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dibyom

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 14, 2020
@tekton-robot tekton-robot merged commit e43c8de into tektoncd:master Feb 14, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cla: yes Trying to make the CLA bot happy with ppl from different companies work on one commit lgtm Indicates that a PR is ready to be merged. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants