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

Add the description to the survey prompt for credentials and parameters #3112

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

Checklist

schristoff commented 3 months ago

Hey! Thank you so much for taking this on. We are actually the value of surveyOptions from #3100 , and then the description can be added to that options so we don't have to modify the function signatures. Would you be willing to refactor after #3100 is merged?

dgannon991 commented 3 months ago

More than happy to! Hopefully github will let me know once that one closes, but feel free to give me a nudge if it looks like I've missed it :)

kichristensen commented 3 months ago

@dgannon991 #3100 is now merged. Thank you for looking into this