DOC: warn about --force for dirty repos #370
Open
Conversation
This file contains 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
|
doctr deploy --force should basically never be used. It forces doctr to run locally, whereas it normally only runs in Travis. It's only useful for development. We should probably hide the flag. doctr deploy stashes your dirty changes. It should unstash them, but maybe that failed. You can try running |
Luckily I've been able to recover. |
asmeurer
reviewed
Aug 3, 2020
| @@ -271,7 +271,9 @@ def deploy(args, parser): | |||
|
|
|||
| if not args.force and not on_travis(): | |||
| parser.error("doctr does not appear to be running on Travis. Use " | |||
| "doctr deploy <target-dir> --force to run anyway.") | |||
| "doctr deploy <target-dir> --force to run anyway.\n\n" | |||
| "WARNING: this will remove any dirty files" | |||
There was a problem hiding this comment.
How about just not mentioning --force at all and also hiding it from the --help output.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What does this PR implement?
It warns about running
doctr deploywith the--forceflag and dirty files.I made the mistake of doing this, and this warning would have prevented my mistake. I am submitting this PR to ask a question: how do I recover those dirty files untracked by Git? Or are they gone forever?