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

Added the description to the credentials generate output #3117

Merged

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

Notes for reviewer

Whilst rebasing the branch I managed to close the original PR somehow (#3112) which is pretty impressively wrong. Apologies. I think I must have pushed up without any commits, and that led to this!

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! 🙇‍♀️

Signed-off-by: David Gannon <19214156+dgannon991@users.noreply.github.com>
Signed-off-by: David Gannon <19214156+dgannon991@users.noreply.github.com>
Signed-off-by: David Gannon <19214156+dgannon991@users.noreply.github.com>
@dgannon991 dgannon991 marked this pull request as ready for review May 16, 2024 21:23
dgannon991 and others added 2 commits May 16, 2024 22:37
Signed-off-by: David Gannon <19214156+dgannon991@users.noreply.github.com>
Copy link
Member

@schristoff schristoff left a comment

Choose a reason for hiding this comment

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

Tested locally and it worked, would love to see a test that uses the porter.yaml and grabs the description out of that, but it's ndb :)

@dgannon991
Copy link
Member Author

@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.

@schristoff schristoff merged commit b544da6 into getporter:main May 20, 2024
15 checks passed
@dgannon991 dgannon991 deleted the feat/3076/add-description-to-survey branch May 21, 2024 19:18
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