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 the description to the survey prompt for credentials and parameters #3112

Conversation

dgannon991
Copy link
Member

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

  • Did you write tests?
  • Did you write documentation?
  • Did you change porter.yaml or a storage document record? Update the corresponding schema file.
  • If this is your first pull request, please add your name to the bottom of our Contributors list. Thank you for making Porter better! 🙇‍♀️

@schristoff
Copy link
Member

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
Copy link
Member Author

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
Copy link
Contributor

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

@dgannon991 dgannon991 force-pushed the feat/3076/add-description-to-survey branch from 73ab290 to a46aa11 Compare May 16, 2024 15:43
@dgannon991 dgannon991 closed this May 16, 2024
@dgannon991 dgannon991 force-pushed the feat/3076/add-description-to-survey branch from a46aa11 to cb4db63 Compare May 16, 2024 15:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Descriptions should be displayed during credential/parameter generation
3 participants