feat: add a prompt to modify users .gitignore (closes netlify#2038) #3595
Conversation
erezrokah added the type: feature 
There was a problem hiding this comment.
@ngonsoto Thank you very much for your PR and taking the time to enhance our CLI!
I want to apologize upfront for being so late with my review 😬
From a consumer perspective there is no reason why the .netlify folder should not be added to the .gitignore, or at least we don't want to promote it. As all our build outputs are there and they should not be committed.
So the user input here would be in 99% the cases a "yes" – I think we can drop it for a better user experience and instead providing a meaningful log message that we adapted the users .gitignore which is stated as solution inside the issue:
Describe the solution you'd like
When the CLI modifies .gitignore we should print a log message reflecting the change to the user
Furthermore a prompt would cause issues on the link command in the CI so we would need to adapt it with a flag to pass without asking. The simpler and better approach in my humble opinion is to informing the user.
Therefore can you please update the PR with a log message?
| Hi @lukasholzer, no problem. I'll be updating the PR with the requested changes. |
| /* Not ignoring .netlify folder. Add to .gitignore */ | ||
| if (!ignorePatterns || !ignorePatterns.patterns.some((pattern) => /(^|\/|\\)\.netlify($|\/|\\)/.test(pattern))) { | ||
| log() | ||
| log('Adding local .netlify folder to .gitignore file...') |
There was a problem hiding this comment.
| log('Adding local .netlify folder to .gitignore file...') | |
| log('Adding local .netlify folder to .gitignore file.') |
3 participants
🎉 Thanks for submitting a pull request! 🎉
Summary
Fixes #2038
Edits to .gitignore file are not shown to the user. This PR adds a prompt if the .netlify folder is not found in the .gitignore file and asks the user if it wants to add it.
For us to review and ship your PR efficiently, please perform the following steps:
passes our tests.
A picture of a cute animal (not mandatory, but encouraged)
