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

Readme can have different formats #85

Open
ericboucher opened this issue Sep 10, 2022 · 0 comments
Open

Readme can have different formats #85

ericboucher opened this issue Sep 10, 2022 · 0 comments

Comments

@ericboucher
Copy link

The Readme stream assumes that we are fetching an .md file but it is not always the case.

Eg. README.rst for flake8-docstrings which leads to a 404 file not found in the tap.

{'type': 'timer', 'metric': 'http_request_duration', 'value': 0.164145, 'tags': {'endpoint': '/projects/{project_id}/repository/files/README%2Emd/raw', 'http_status_code': 404, 'status': 'failed', 'url': '/api/v4/projects/140322/repository/files/README.md/raw', 'context': {'project_id': 140322, 'project_path': 'pycqa/flake8-docstrings'}}}

We could:

  1. use the readme_url available in the project object
  2. try different exetnsion, probably .md and .rst would cover 99.9% of cases

But at the very least we should add error handling around missing readmes :)

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

1 participant