Skip to content

README not copied when using --template #104

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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
craigsdennis opened this issue Jan 14, 2020 · 4 comments · Fixed by #116
Closed

README not copied when using --template #104

craigsdennis opened this issue Jan 14, 2020 · 4 comments · Fixed by #116
Assignees
@philnash

Comments

@craigsdennis
Copy link

The README from the function template does not get copied across during initialization from a template.

It would be ideal to be able to use README's for functions that require additional setup/instructions.

Definitely open to other ways of providing setup instruction as well.
@welcome
Copy link

welcome bot commented Jan 14, 2020

Thank you so much for opening your first issue in this project! We'll try to get back to it as quickly as possible. While you are waiting...here's a random picture of a corgi (powered by dog.ceo)

picture of dog

@philnash
Copy link
Contributor

This is a good idea, but the thing that bugs me about it is where to put downloaded READMEs. Function templates are run both in new and existing projects and can even add to the existing sub directories.

So, proposal:

We include a readmes/instructions directory and download the template's README to readmes/${templateName}.md. The only reason to not download a README is if readmes/${templateName}.md already exists and this is presumably because you liked the template so much you downloaded it again.

Finally, we log to the console that instructions for the function you just initialized are available in readmes/${templateName}.md.

What do you think?

@dkundel
Copy link
Contributor

dkundel commented Jan 14, 2020

I think that's a great solution for this

@craigsdennis
Copy link
Author

Sounds great! 👍

@philnash philnash mentioned this issue Mar 13, 2020
Merged
1 task
dkundel pushed a commit that referenced this issue Mar 18, 2020
@philnash
feat(templates): template README downloaded and saved to readmes… (#116)
523e09a 
* feat(templates): template README downloaded and saved to readmes dir

* fixup(templates): handle blank namespace and same namespace

fixes: #104
@snyk-bot snyk-bot mentioned this issue Jul 15, 2020
Merged
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@philnash philnash

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat(templates): template README downloaded and saved to readmes dir philnash/twilio-run
3 participants
@philnash @dkundel @craigsdennis