Check root #163
Check root #163
Conversation
If we are in a git repo but not at the root of it, print error and allow user to ``--force`` doctr to run anyway. If not in a git repo at all, raise a RuntimeError
| Check if current working directory is root dir of git repo. | ||
| Return ``False`` if it isn't. | ||
| """ | ||
| repo = subprocess.run(['git', 'rev-parse', '--show-toplevel'], |
There was a problem hiding this comment.
Can't you just check if the current directory has a .git directory?
There was a problem hiding this comment.
That wouldn't check if we are in a git repo at all, but I don't see the point have having the distinct error messages in that case.
There was a problem hiding this comment.
My thought was that someone might want to run doctr in a subdirectory for some specific reason? I can't think of what that would be, but that was the thought.
There was a problem hiding this comment.
Well it doesn't have to be at the root of the repo, unless I'm mistaken, as long as the paths to the key and the other arguments are given to it, relative to the current directory. It does need to be in the repo, as it calls git.
So I actually think it should only error when it is not in the git repo (it will error anyway, eventually, because git will complain as soon as doctr calls it), and warn, but not error when it isn't, just so it is easier for people to debug if they accidentally are cd'd to the wrong directory and are trying to figure out why doctr failed.
There was a problem hiding this comment.
OTOH, maybe weird stuff will happen when checking out gh-pages if we aren't in the root (unless the directory we are in isn't tracked, or is in both branches).
|
The tests are failing from that race condition again. |
|
How about checking current working directory is TRAVIS_BUILD_DIR? |
|
This is for |
If we are in a git repo but not at the root of it, print error and allow
user to
--forcedoctr to run anyway.If not in a git repo at all, raise a RuntimeError
Should address #162