Skip to content

Readme can have different formats #85

@ericboucher

Description

@ericboucher

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 :)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions