getporter / porter

Porter enables you to package your application artifact, client tools, configuration and deployment logic together as an installer that you can distribute, and install with a single command.
https://porter.sh
Apache License 2.0
1.22k stars 204 forks source link

Added the description to the credentials generate output #3117

Closed dgannon991 closed 3 months ago

dgannon991 commented 3 months ago

What does this change

Optionally displays the description for parameters and credentials in the survey prompt (if present)

The following screengrab was generated with this credential set:

credentials:
 - name: kubeconfig
   path: /home/nonroot/.kube/config
   description: The path to your kubeconfig (usually something like /home/nonroot/.kube/config)
 - name: username
   env: USERNAME

image

What issue does it fix

Closes #3076

Notes for reviewer

Whilst rebasing the branch I managed to close the original PR somehow (https://github.com/getporter/porter/pull/3112) which is pretty impressively wrong. Apologies. I think I must have pushed up without any commits, and that led to this!

Checklist

dgannon991 commented 3 months ago

@schristoff - happy to try and get some tests written for that if you'd like (I'm not sure there are any currently due to the interactive nature.) LMK.