docs command: don't show error on console when not a git repository #3700
Conversation
| puts "WARNING there is not inside git worktree. some features are not available." | ||
| return | ||
| end | ||
|
|
||
| remotes = `git remote -v` |
There was a problem hiding this comment.
Maybe it's enough to replace it with git remote -v 2>/dev/null?
There was a problem hiding this comment.
I don't know about git remote -v perfectly. Maybe it causes an error event inside git work-tree. I think we should use git rev-parse --is-inside-work-tree because it is official way to check whether inside git work-tree.
There was a problem hiding this comment.
git remote returns list of remotes with remote url after name (because of verbose -v switch). Adding 2>/dev/null will silence error while leaving status code intact, thus triggering return on the next line.
There was a problem hiding this comment.
git remote -v error message except fatal: Not a git repository may be useful for us, should not silence it. So, we should detect whether inside work-tree before git remote.
makenowjust
changed the title
makenowjust
force-pushed
the
fix/doc/check-git-worktree
branch
from
89d48e8
to
68d011e
Compare
makenowjust
changed the title
makenowjust
force-pushed
the
fix/doc/check-git-worktree
branch
from
68d011e
to
4f511a1
Compare
makenowjust
changed the title
makenowjust
force-pushed
the
fix/doc/check-git-worktree
branch
from
4f511a1
to
6777410
Compare
makenowjust
changed the title
| @@ -20,6 +20,9 @@ class Crystal::Doc::Generator | |||
| @types = {} of Crystal::Type => Doc::Type | |||
| @repo_name = "" | |||
| compute_repository | |||
| if @repo_name == "" | |||
| puts "WARNING cannot detect GitHub repository. some features are not available." | |||
There was a problem hiding this comment.
I'd use a comma: "...repository, some features ..."
|
Thank you! I wonder if we should show a warning or just silently do nothing if a git repo isn't found. You won't get links to the source code, but since that only works with github... if you are not using github then there isn't anything public to show links to, so saying nothing seems to be OK. (eventually we could add links to bitbuckets and other repositories) What do you think? |
makenowjust
force-pushed
the
fix/doc/check-git-worktree
branch
from
6777410
to
8c8c095
Compare
| @@ -278,6 +281,10 @@ class Crystal::Doc::Generator | |||
| end | |||
|
|
|||
| def compute_repository | |||
| # check whether inside git work-tree | |||
| `git rev-parse --is-inside-work-tree >/dev/null 2>&1` | |||
There was a problem hiding this comment.
Is this additional command really necessary?
There was a problem hiding this comment.
The below git remote -v will output an error message without this. This is needed.
|
This PR is stalled. I don't know what needs to be done to continue. If there's no activity, it will be closed in two weeks. |
makenowjust
force-pushed
the
fix/doc/check-git-worktree
branch
from
8c8c095
to
f51de4e
Compare
|
Sorry for delay. I'm sure preventing raw git error message is good, but I'm not sure it should show warning message. |
asterite
changed the title
…rystal-lang#3700) * Show warning message if cannot detect GitHub repository * Remove warning message not to detect GitHub/GitLab repo
Currently, we get git error message when
crystal docsrun not inside git repository:It is unkind. This pull request fixes to output warning message instead of git error.