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

Improve errors for topic documentation #1480

Open
JakeSCahill opened this issue Oct 18, 2024 · 2 comments
Open

Improve errors for topic documentation #1480

JakeSCahill opened this issue Oct 18, 2024 · 2 comments

Comments

@JakeSCahill
Copy link
Contributor

I had topic documentation configured to use a specific branch that later got deleted. The error I got from Console suggested that my repo was invalid but it was the branch. Could we improve the error to report whether the repo doesn't exist or the branch or the specified path?

2024-10-18 14:33:01 {"level":"info","ts":"2024-10-18T13:33:01.206Z","msg":"cloning git repository","repository_url":"https://github.com/redpanda-data/docs","url":"https://github.com/redpanda-data/docs"}
2024-10-18 14:33:05 {"level":"fatal","ts":"2024-10-18T13:33:05.978Z","msg":"failed to start console service","error":"failed to start git service: failed to clone git repo: reference not found"}
@weeco
Copy link
Contributor

weeco commented Oct 18, 2024

The error indicates "reference not found". A reference may be a branch, tag or commit sha. The error itself is emitted by the git library we're using. We could catch this case and reword to "branch not found" since we currently only support branches.

@JakeSCahill
Copy link
Contributor Author

I think logging the branch name would also help.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants