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

Already on GitHub? Sign in to your account

Jump to bottom

Warn users when traversing special directories, recommend to ignore #3436

Closed
skshetry opened this issue Mar 4, 2020 · 1 comment · Fixed by #4229
Closed

Warn users when traversing special directories, recommend to ignore #3436

skshetry opened this issue Mar 4, 2020 · 1 comment · Fixed by #4229
Labels
good first issue p3-nice-to-have It should be done this or next sprint

Comments

@skshetry
Copy link
Member

skshetry commented Mar 4, 2020 •
edited
Loading

Currently, we ignore .dvc, .git and .hg directories by default. Still, we might be traversing through other special directories such as: node_modules, .venv/venv/env, __pycache__, dist/eggs/wheels, htmlcov, docs, .mypy_cache, .pytest_cache, etc.

We could throw warning if the users have not ignored these kind of directories and recommend them to add to .dvcignore. We could start with a small set of such directories.

Context:

Exactly. There can be tons of special/hidden dirs you don't want DVC to traverse (.idea/ .project/
.env/ .ds_store/ venv/), and you can just add them to .gitignore or .dvcignore. Why are we secretly
integrating with Mercurial if we don't actually support it? What if someone wants to version a .hg
dir? (edge case I know)

It just seems very arbitrary to me, but OK maybe I'm missing something...

Originally posted by @jorgeorpinel in #3257 (comment)
@triage-new-issues triage-new-issues bot added the triage Needs to be triaged label Mar 4, 2020
@shcheklein
Copy link
Member

@skshetry please, consider adding a link to the discussion - I think it can be valuable.

@skshetry skshetry mentioned this issue Mar 4, 2020
Merged
3 tasks
@efiop efiop added the p3-nice-to-have It should be done this or next sprint label Mar 10, 2020
@triage-new-issues triage-new-issues bot removed the triage Needs to be triaged label Mar 10, 2020
@skshetry skshetry linked a pull request Jul 17, 2020 that will close this issue
Special dir warning #3436 #4229
Merged
efiop added a commit that referenced this issue Aug 12, 2020
@aerubanov @efiop
Special dir warning #3436 (#4229)
5cb36fc 
* add special folder warning

* add special folder warning

* remove special folder warning, start working on default dvcignore

* add default .dvcignote and templates

* remove dvcignore templates

* change text and add tests

* refactor

* dvcignore: ignore comments

* adjust tests

Co-authored-by: Ruslan Kuprieiev <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue p3-nice-to-have It should be done this or next sprint
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Special dir warning #3436 aerubanov/dvc
3 participants
@shcheklein @efiop @skshetry