status: Show friendly message for empty project. #4609
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When there are no stages in the repo, show a friendly message to that effect and display a getting-started URL. Fixes treeverse#4395.
Contributor
Author
|
Hm, apparently the message line is two characters too long. I had formatted with black which didn't complain, so I had assumed I was good to go. Let me just update things here... |
skshetry
reviewed
Sep 24, 2020
| STATUS_LEN = 20 | ||
| STATUS_INDENT = "\t" | ||
| UP_TO_DATE_MSG = "Data and pipelines are up to date." | ||
| EMPTY_PROJECT_MSG = ( |
Collaborator
There was a problem hiding this comment.
Contributor
Author
There was a problem hiding this comment.
Can't argue with that. Fixed in 656efd5.
Collaborator
|
Hi, @DDR0. Thanks for the PR. Looks good, left one suggestion. 🙂 |
Contributor
Author
|
Restyled didn't like my imports. I've incorporated its PR at #4610. However, I'm not sure why the python lint is failing - it claims it doesn't like my patch format, but this is not something I really have control over here. Github rather hides patch format from me, but I can provide it via a traditional email if desired. |
Contributor
Author
|
Unclosed this PR, as restyled-bot closed its PR too when I did so. |
Since I'd pulled the old syntax out of repo/init.py, I've fixed that up as well so no one makes that mistake again. Note that this adds <>s around the link text, unlike before: +---------------------------------------------------------------------+ | | | DVC has enabled anonymous aggregate usage analytics. | | Read the analytics documentation (and how to opt-out) here: | | <https://dvc.org/doc/user-guide/analytics> | | | +---------------------------------------------------------------------+ This is probably fine, since if we're going to have a standard link format we might as well stick with it consistently. If we don't like it, we can change format_link() I guess.
DDR0
force-pushed
the
friendly-status-output-for-empty-project
branch
from
656efd5 to
26963e4
Compare
Contributor
Author
|
Since |
Contributor
Author
|
Ah, looks like it didn't like the formatting in the patch, not of the patch itself. Should be good now. 👍 |
efiop
reviewed
Sep 24, 2020
Contributor
Author
|
Sounds good to me.
I had only mentioned data because I'm not quite sure what the condition is
checking. I was guessing it was just for data, and I didn't want to print a
misleading message.
…On Thu., Sep. 24, 2020, 11:43 a.m. Ruslan Kuprieiev, < ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In dvc/command/status.py
<#4609 (comment)>:
> + "There is no data tracked in this project yet.\n"
+ "See {link} to get started!"
+ ).format(link=format_link("https://dvc.org/doc/start/data-versioning"))
How about
⬇️ Suggested change
- "There is no data tracked in this project yet.\n"
- "See {link} to get started!"
- ).format(link=format_link("https://dvc.org/doc/start/data-versioning"))
+ "There are no data or pipelines tracked in this project yet.\n"
+ "See {link} to get started!"
+ ).format(link=format_link("https://dvc.org/doc/start"))
? Since it is about both.
—
You are receiving this because you modified the open/close state.
Reply to this email directly, view it on GitHub
<#4609 (review)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAGSTIYU22I5L375LSP7PGTSHOHN3ANCNFSM4RXTWGDQ>
.
|
Contributor
Author
|
Excellent to hear. I've made a note here for future reference to check this.
…On Wed., Sep. 30, 2020, 12:33 p.m. Jorge Orpinel, ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In dvc/command/status.py
<#4609 (comment)>:
> + elif not self.repo.stages:
+ logger.info(self.EMPTY_PROJECT_MSG)
else:
logger.info(self.UP_TO_DATE_MSG)
OK never mind. I checked all the instances and none seem to be for this
case (no data/pipelines in the project yet). All good here!
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#4609 (comment)>, or
unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAGSTI3FLKHGYHFW7MQ5GP3SIN2YBANCNFSM4RXTWGDQ>
.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When there are no stages in the repo, show a friendly message to that effect and display a getting-started URL.
Fixes #4395.
❗ I have followed the Contributing to DVC checklist.
📖 If this PR requires documentation updates, I have created a separate PR (or issue, at least) in dvc.org and linked it here.
Note: This PR, as well as the incidental #4606, are part of the application process for a job with DVC.