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

Jump to bottom

Add description to builder config #172

Closed
ekcasey opened this issue May 2, 2019 · 4 comments
Closed

Add description to builder config #172

ekcasey opened this issue May 2, 2019 · 4 comments
Assignees
@ameyer-pivotal
Labels
type/enhancement Issue that requests a new feature or improvement.
Milestone
0.2.0

Comments

@ekcasey
Copy link
Member

ekcasey commented May 2, 2019

inspect-builder

Given I run pack create-builder my-builder -b builder.toml with the following field in the builder.toml file

description = "A short description of my builder"

When I run pack inspect-builder my-builder then I observe the following field in the output

Desciption: A short description of my builder

suggest-builders w/ description

Given a suggested builder has been created with a description
When I run pack suggest-builders
Then The desciption field in the output will be populated with the configured description

suggest-builders w/o description (Backwards Compatibility)

Given a suggested builder has an empty description
When I run pack suggest-builders
Then The current hard-coded description will be printed
@ekcasey ekcasey added the type/enhancement Issue that requests a new feature or improvement. label May 2, 2019
@ameyer-pivotal ameyer-pivotal self-assigned this May 8, 2019
ameyer-pivotal added a commit that referenced this issue May 8, 2019
@ameyer-pivotal
Support builder description in builder.toml
a13d711 
- Shown in inspect-builder output
- Shown in suggested builder output (use default descriptions if not present)

[#172]

Signed-off-by: Andrew Meyer <ameyer@pivotal.io>
@ameyer-pivotal ameyer-pivotal mentioned this issue May 8, 2019
Merged
@ekcasey ekcasey added the v0.2.0 label May 10, 2019
@mgibson1121
Copy link
Member

@ameyer-pivotal Validated cases 1 and 3, but don't know how to modify the suggested builders. Would I just docker pull them, add a description, and then run pack create-builder? I also don't want to mess with them as they are the "canonical" builders.

@ameyer-pivotal
Copy link
Contributor

ameyer-pivotal commented May 10, 2019 •
edited
Loading

@mgibson1121 That's a good point... @sclevine @ekcasey Are y'all OK deferring part 2 acceptance and just validating it when we create new builders? It only looks at remote builders and we don't want to mess with the published ones just yet.

@mgibson1121
Copy link
Member

This story is accepted

@ekcasey
Copy link
Member Author

ekcasey commented May 10, 2019

done on master, will ship in v0.2.0

@ekcasey ekcasey closed this as completed May 10, 2019
@jromero jromero added this to the 0.2.0 milestone Aug 19, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ameyer-pivotal ameyer-pivotal

Labels
type/enhancement Issue that requests a new feature or improvement.
Projects
None yet
Milestone
0.2.0
Development

No branches or pull requests
4 participants
@jromero @ekcasey @mgibson1121 @ameyer-pivotal