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

deprecate: using Dvcfile is confusing and maybe should be deprecated #2391

Closed
dashohoxha opened this issue Aug 13, 2019 · 8 comments
Closed
Labels
bug Did we break something? enhancement Enhances DVC p2-medium Medium priority, should be done, but less important ui user interface / interaction

Comments

@dashohoxha
Copy link
Contributor

The command dvc pipeline show --ascii <targets> is supposed to work without any targets as well (as explained by the help message: dvc pipeline show --help). However it complains instead about the absence of Dvcfile:

WARNING: assuming default target 'Dvcfile'.
ERROR: failed to show pipeline for 'Dvcfile' - 'Dvcfile' does not exist.

This is confusing for the users. Without any targets, it should show all the pipelines available (as the help message says). This would be more reasonable than searching for a "Dvcfile".

Moreover, I think that using Dvcfile as a default target should be deprecated in general. It is much better to fail and ask for a .dvc file, when it is missing, than to assume that the default is Dvcfile.

@dashohoxha
Copy link
Contributor Author

Related: #2392

@pared
Copy link
Contributor

pared commented Aug 13, 2019

Some context

@efiop efiop added enhancement Enhances DVC p3-nice-to-have It should be done this or next sprint ui user interface / interaction labels Aug 14, 2019
@efiop
Copy link
Contributor

efiop commented Aug 21, 2019

Moreover, I think that using Dvcfile as a default target should be deprecated in general. It is much better to fail and ask for a .dvc file, when it is missing, than to assume that the default is Dvcfile.

Dvcfile is similar to Makefile and is used for other commands like dvc repro to provide a feature that allows you to run your command without a specific target, so the creator of the project could decide which targets should be reproduced by default. It is also useful when you have a dedicated directory for your pipeline step (e.g. https://github.com/nestauk/gateway_to_cookies/tree/master/pipe). I don't think that pipeline show issue is a good enough reason to abandon Dvcfile's in general, the reasons behind pipeline show behaviour are discussed #2392 . Also, removing Dvcfile would break backward compatibility. Closing this for now.

@efiop efiop closed this as completed Aug 21, 2019
@shcheklein
Copy link
Member

I think the help message should be updated. It looks like an UI bug to me at the very least.

@shcheklein shcheklein reopened this Aug 21, 2019
@shcheklein shcheklein added bug Did we break something? p2-medium Medium priority, should be done, but less important and removed p3-nice-to-have It should be done this or next sprint labels Aug 21, 2019
@dashohoxha
Copy link
Contributor Author

Dvcfile is similar to Makefile

@efiop Everything that you say about Dvcfile may be right, but IMHO the analogy with a Makefile is broken. I would love it if Dvcfile was similar to Makefile (or Dockerfile).

@efiop
Copy link
Contributor

efiop commented Aug 21, 2019

@shcheklein It should be a part of #2392 , no need to keep a duplicate issue.

@efiop
Copy link
Contributor

efiop commented Aug 21, 2019

@dashohoxha Sure, it is not a 1to1 conformity, I'm just saying that the idea behind a default file name is a similar one to both Makefile and Dockerfile.

@efiop
Copy link
Contributor

efiop commented Sep 9, 2019

Closing in favor of #2392

@efiop efiop closed this as completed Sep 9, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Did we break something? enhancement Enhances DVC p2-medium Medium priority, should be done, but less important ui user interface / interaction
Projects
None yet
Development

No branches or pull requests

4 participants