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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add a details or equivalent field to Pulumi Project File's template options for additional information or instructions #15360

Open
zbuchheit opened this issue Feb 2, 2024 · 2 comments 路 May be fixed by #15813
Open

Add a details or equivalent field to Pulumi Project File's template options for additional information or instructions #15360

zbuchheit opened this issue Feb 2, 2024 · 2 comments 路 May be fixed by #15813
Labels
area/new pulumi new, templates customer/feedback Feedback from customers customer/lighthouse Lighthouse customer bugs kind/enhancement Improvements or new features

Comments

@zbuchheit
Copy link

zbuchheit commented Feb 2, 2024 •
edited

Hello!

  • Vote on this issue by adding a 馃憤 reaction
  • If you want to implement this feature, comment to let us know (we'll work with you on design, scheduling, etc.)

Issue details

It would be nice to have the ability to display additional instruction or information to users once they have selected a template. The description field gets displayed on template selection, but can be limited in how much information it can display for a user.

Current Implementation:

Code

name: ${PROJECT}
description: ${DESCRIPTION}
runtime: nodejs
template:
  description: A Description
  important: true

Output

Please choose a template (16/227 shown):
 azure-typescript                   A Description
 
Enter a value or leave blank to accept the (default), and press <ENTER>.
Press ^C at any time to quit.

project name (pulumi-new-test):  
project description (A Description):

Preferred Implementation:

Code

name: ${PROJECT}
description: ${DESCRIPTION}
runtime: nodejs
template:
  description: A Description
  details: Here are some additional instructions that will guide you to use this template
  important: true
Please choose a template (16/227 shown):
 azure-typescript                   A Description
 
Here are some additional instructions that will guide you to use this template

Enter a value or leave blank to accept the (default), and press <ENTER>.
Press ^C at any time to quit.

project name (pulumi-new-test):  
project description (A Description):

Affected area/feature

CLI
@zbuchheit zbuchheit added kind/enhancement Improvements or new features needs-triage Needs attention from the triage team customer/feedback Feedback from customers customer/lighthouse Lighthouse customer bugs labels Feb 2, 2024
@zbuchheit zbuchheit changed the title Allow separate short and long descriptions in Pulumi.yaml for template display Add a details or equivalent field to Pulumi Project File's template options for additional information or instructions Feb 2, 2024
@justinvp justinvp added area/new pulumi new, templates and removed needs-triage Needs attention from the triage team labels Feb 5, 2024
@zbuchheit zbuchheit mentioned this issue Mar 25, 2024
Open
@mikhailshilkov mikhailshilkov linked a pull request Mar 28, 2024 that will close this issue
Open
6 tasks
@mikhailshilkov
Copy link
Member

@zbuchheit I opened a PR to do so: #15813

A question: there is an existing quickstart property in templates, that prints details after the template creation. Could you confirm that the request here is importantly different in that it prints the instructions before users provide template values, and should only be shown ahead of user interaction?

Also, if we introduce a new template properties, all template users will have to be on a fresh CLI version to use that template, otherwise their pulumi new would fail with an error. Is that acceptable?

@zbuchheit
Copy link
Author

I have solicited feedback from the users affected by this to see if quickstart is sufficient for their use case. I will update this once I hear back.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area/new pulumi new, templates customer/feedback Feedback from customers customer/lighthouse Lighthouse customer bugs kind/enhancement Improvements or new features
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add an 'instructions' to Pulumi templates to display them at pulumi new pulumi/pulumi
3 participants
@justinvp @mikhailshilkov @zbuchheit