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 descriptive output when creating templates #6103

Merged
merged 2 commits into from
Feb 17, 2022

Conversation

Radvendii
Copy link
Contributor

this includes a welcomeText attribute which can be set in the
template, as well as outputing which files were created.

#4503

this includes a `welcomeText` attribute which can be set in the
template, as well as outputing which files were created.
@edolstra
Copy link
Member

I think the welcomeText should be in Markdown. It can be rendered easily by calling renderMarkdownToTerminal().

@@ -45,6 +49,10 @@ outputs = { self }: {
templates.rust = {
path = ./rust;
description = "A simple Rust/Cargo project";
welcomeText = ''
You've created a simple Rust/Cargo template.
Visit https://www.rust-lang.org/ for more info.
Copy link
Member

Choose a reason for hiding this comment

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

I don't think this is a useful link. It should point to a Nix-specific document.

I understand that it's just an example, but we shouldn't set a wrong precedent.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

let me know if it's better now

@edolstra edolstra merged commit a768e85 into NixOS:master Feb 17, 2022
@Radvendii Radvendii deleted the welcomeText branch February 17, 2022 20:06
jian-lin added a commit to linj-fork/nix that referenced this pull request Nov 21, 2023
This number is not updated when welcomeText is added[1][2].

[1]: f3a2940
[2]: NixOS#6103
jian-lin added a commit to linj-fork/nix that referenced this pull request Nov 21, 2023
This number is not updated when welcomeText is added[1][2].

[1]: f3a2940
[2]: NixOS#6103
fricklerhandwerk pushed a commit that referenced this pull request Nov 21, 2023
This number is not updated when welcomeText is added[1][2].

[1]: f3a2940
[2]: #6103
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants